Introduced SMTP notification #5535
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,4 +4,5 @@ type ExternalEmailer = string | |
|
|
||
| const ( | ||
| Sendgrid ExternalEmailer = "sendgrid" | ||
| SMTP ExternalEmailer = "smtp" | ||
| ) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| package implementations | ||
|
|
||
| import ( | ||
| "crypto/tls" | ||
| "fmt" | ||
| "net/smtp" | ||
| "strings" | ||
|
|
||
| "github.com/flyteorg/flyte/flyteadmin/pkg/async/notifications/interfaces" | ||
| "github.com/flyteorg/flyte/flyteadmin/pkg/errors" | ||
| runtimeInterfaces "github.com/flyteorg/flyte/flyteadmin/pkg/runtime/interfaces" | ||
| "github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin" | ||
| "github.com/flyteorg/flyte/flyteplugins/go/tasks/pluginmachinery/core" | ||
| "github.com/flyteorg/flyte/flytestdlib/logger" | ||
| "github.com/flyteorg/flyte/flytestdlib/promutils" | ||
| "golang.org/x/net/context" | ||
| "google.golang.org/grpc/codes" | ||
| ) | ||
|
|
||
| type SMTPEmailer struct { | ||
| config *runtimeInterfaces.NotificationsEmailerConfig | ||
| systemMetrics emailMetrics | ||
| tlsConf *tls.Config | ||
| auth *smtp.Auth | ||
| } | ||
|
|
||
| func (s *SMTPEmailer) SendEmail(ctx context.Context, email admin.EmailMessage) error { | ||
|
|
||
| newClient, err := smtp.Dial(s.config.EmailerConfig.SMTPServer + ":" + s.config.EmailerConfig.SMTPPort) | ||
|
|
||
| if err != nil { | ||
| return s.emailError(ctx, fmt.Sprintf("Error creating email client: %s", err)) | ||
| } | ||
|
|
||
| defer newClient.Close() | ||
|
|
||
| if err = newClient.Hello("localhost"); err != nil { | ||
| return s.emailError(ctx, fmt.Sprintf("Error initiating connection to SMTP server: %s", err)) | ||
| } | ||
|
|
||
| if ok, _ := newClient.Extension("STARTTLS"); ok { | ||
| if err = newClient.StartTLS(s.tlsConf); err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| if ok, _ := newClient.Extension("AUTH"); ok { | ||
| if err = newClient.Auth(*s.auth); err != nil { | ||
| return s.emailError(ctx, fmt.Sprintf("Error authenticating email client: %s", err)) | ||
| } | ||
| } | ||
|
|
||
| if err = newClient.Mail(email.SenderEmail); err != nil { | ||
| return s.emailError(ctx, fmt.Sprintf("Error creating email instance: %s", err)) | ||
| } | ||
|
|
||
| for _, recipient := range email.RecipientsEmail { | ||
| if err = newClient.Rcpt(recipient); err != nil { | ||
| logger.Errorf(ctx, "Error adding email recipient: %s", err) | ||
| } | ||
| } | ||
|
|
||
| writer, err := newClient.Data() | ||
|
|
||
| if err != nil { | ||
| return s.emailError(ctx, fmt.Sprintf("Error adding email recipient: %s", err)) | ||
| } | ||
|
|
||
| _, err = writer.Write([]byte(createMailBody(s.config.Sender, email))) | ||
|
|
||
| if err != nil { | ||
| return s.emailError(ctx, fmt.Sprintf("Error writing mail body: %s", err)) | ||
| } | ||
|
|
||
| err = writer.Close() | ||
|
|
||
| if err != nil { | ||
| return s.emailError(ctx, fmt.Sprintf("Error closing mail body: %s", err)) | ||
| } | ||
|
|
||
| err = newClient.Quit() | ||
|
|
||
| if err != nil { | ||
| return s.emailError(ctx, fmt.Sprintf("Error quitting mail agent: %s", err)) | ||
| } | ||
|
|
||
| s.systemMetrics.SendSuccess.Inc() | ||
| return nil | ||
| } | ||
|
|
||
| func (s *SMTPEmailer) emailError(ctx context.Context, error string) error { | ||
| s.systemMetrics.SendError.Inc() | ||
| logger.Error(ctx, error) | ||
| return errors.NewFlyteAdminErrorf(codes.Internal, "errors were seen while sending emails") | ||
| } | ||
|
|
||
| func createMailBody(emailSender string, email admin.EmailMessage) string { | ||
| headerMap := make(map[string]string) | ||
| headerMap["From"] = emailSender | ||
| headerMap["To"] = strings.Join(email.RecipientsEmail, ",") | ||
| headerMap["Subject"] = email.SubjectLine | ||
| headerMap["Content-Type"] = "text/html; charset=\"UTF-8\"" | ||
|
|
||
| mailMessage := "" | ||
|
|
||
| for k, v := range headerMap { | ||
| mailMessage += fmt.Sprintf("%s: %s\r\n", k, v) | ||
| } | ||
|
|
||
| mailMessage += "\r\n" + email.Body | ||
|
|
||
| return mailMessage | ||
| } | ||
|
|
||
| func NewSMTPEmailer(ctx context.Context, config runtimeInterfaces.NotificationsConfig, scope promutils.Scope, sm core.SecretManager) interfaces.Emailer { | ||
| var tlsConfiguration *tls.Config | ||
| emailConf := config.NotificationsEmailerConfig.EmailerConfig | ||
|
|
||
| smtpPassword, err := sm.Get(ctx, emailConf.SMTPPasswordSecretName) | ||
| if err != nil { | ||
| logger.Debug(ctx, "No SMTP password found.") | ||
| smtpPassword = "" | ||
| } | ||
|
|
||
| auth := smtp.PlainAuth("", emailConf.SMTPUsername, smtpPassword, emailConf.SMTPServer) | ||
|
|
||
| tlsConfiguration = &tls.Config{ | ||
| InsecureSkipVerify: emailConf.SMTPSkipTLSVerify, // #nosec G402 | ||
| ServerName: emailConf.SMTPServer, | ||
| } | ||
|
|
||
| return &SMTPEmailer{ | ||
| config: &config.NotificationsEmailerConfig, | ||
| systemMetrics: newEmailMetrics(scope.NewSubScope("smtp")), | ||
| tlsConf: tlsConfiguration, | ||
| auth: &auth, | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| package implementations | ||
|
|
||
| import ( | ||
| "context" | ||
| "testing" | ||
|
|
||
| "github.com/flyteorg/flyte/flyteadmin/pkg/runtime/interfaces" | ||
| "github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin" | ||
| "github.com/flyteorg/flyte/flyteplugins/go/tasks/pluginmachinery/core/mocks" | ||
| "github.com/flyteorg/flyte/flytestdlib/promutils" | ||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/mock" | ||
| ) | ||
|
|
||
| func getNotificationsEmailerConfig() interfaces.NotificationsConfig { | ||
| return interfaces.NotificationsConfig{ | ||
| Type: "", | ||
| Region: "", | ||
| AWSConfig: interfaces.AWSConfig{}, | ||
| GCPConfig: interfaces.GCPConfig{}, | ||
| NotificationsPublisherConfig: interfaces.NotificationsPublisherConfig{}, | ||
| NotificationsProcessorConfig: interfaces.NotificationsProcessorConfig{}, | ||
| NotificationsEmailerConfig: interfaces.NotificationsEmailerConfig{ | ||
| EmailerConfig: interfaces.EmailServerConfig{ | ||
| ServiceName: SMTP, | ||
| SMTPServer: "smtpServer", | ||
| SMTPPort: "smtpPort", | ||
| SMTPUsername: "smtpUsername", | ||
| SMTPPasswordSecretName: "smtp_password", | ||
| }, | ||
| Subject: "subject", | ||
| Sender: "sender", | ||
| Body: "body"}, | ||
| ReconnectAttempts: 1, | ||
| ReconnectDelaySeconds: 2} | ||
| } | ||
|
|
||
| func TestEmailCreation(t *testing.T) { | ||
| email := admin.EmailMessage{ | ||
| RecipientsEmail: []string{"[email protected]", "[email protected]"}, | ||
| SubjectLine: "subject", | ||
| Body: "Email Body", | ||
| SenderEmail: "[email protected]", | ||
| } | ||
|
|
||
| body := createMailBody("[email protected]", email) | ||
| assert.Equal(t, "From: [email protected]\r\nTo: [email protected],[email protected]\r\nSubject: subject\r\nContent-Type: text/html; charset=\"UTF-8\"\r\n\r\nEmail Body", body) | ||
| } | ||
|
|
||
| func TestNewSmtpEmailer(t *testing.T) { | ||
| secretManagerMock := mocks.SecretManager{} | ||
| secretManagerMock.On("Get", mock.Anything, "smtp_password").Return("password", nil) | ||
|
|
||
| notificationsConfig := getNotificationsEmailerConfig() | ||
|
|
||
| smtpEmailer := NewSMTPEmailer(context.Background(), notificationsConfig, promutils.NewTestScope(), &secretManagerMock) | ||
|
|
||
| assert.NotNil(t, smtpEmailer) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just to confirm, this is the intended behavior? If admin needs to send a thousand emails, it has to make a new client each time?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, this is intended behavior. When using the built-in email client of Go, most examples you find work that way. Also with the integration into the Notifications processor this is the simplest approach. Establishing a connection does not seem to be a very complex undertaking when looking at the source code of the email client.
I agree that keeping the connection is more efficient. But it also makes the code more complex, because the connection state needs to be maintained over an instance - so whenever an email is meant to be sent, it first needs to be checked if the connection is still alive.
If you want me to, I can refactor it to only open a connection once to the SMTP server.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just checked again the internal implementation of Golang's smtp client: It appears that the client implementation seems to be not multi-thread-safe. Every client instance keeps an internal state between function calls - so when reusing the same client while sending an email for writing another mail can lead to weird behavior.
My assumption is that there is only a single email processor per Flyte Admin instance. That means that there should be no concurrent email processing on any Flyte Admin instance, which makes it safe to reuse an existing Flyste client.