fix: correctly close SMTP message and await response (#14495)

dannykopping · web-flow · commit c90be9b0c10b · 2024-08-30T11:37:50.000+02:00
diff --git a/coderd/notifications/dispatch/smtp.go b/coderd/notifications/dispatch/smtp.go
@@ -183,7 +183,6 @@ func (s *SMTPHandler) dispatch(subject, htmlBody, plainBody, to string) Delivery
 		if err != nil {
 			return true, xerrors.Errorf("message transmission: %w", err)
 		}
-		defer message.Close()
 
 		// Create message headers.
 		msg := &bytes.Buffer{}
@@ -251,6 +250,10 @@ func (s *SMTPHandler) dispatch(subject, htmlBody, plainBody, to string) Delivery
 			return false, xerrors.Errorf("write body buffer: %w", err)
 		}
 
+		if err = message.Close(); err != nil {
+			return true, xerrors.Errorf("delivery failure: %w", err)
+		}
+
 		// Returning false, nil indicates successful send (i.e. non-retryable non-error)
 		return false, nil
 	}
diff --git a/coderd/notifications/dispatch/smtp_test.go b/coderd/notifications/dispatch/smtp_test.go
@@ -62,6 +62,7 @@ func TestSMTP(t *testing.T) {
 		expectedErr      string
 		retryable        bool
 		useTLS           bool
+		failOnDataFn     func() error
 	}{
 		/**
 		 * LOGIN auth mechanism
@@ -381,6 +382,21 @@ func TestSMTP(t *testing.T) {
 			toAddrs:          []string{to},
 			expectedAuthMeth: sasl.Plain,
 		},
+		/**
+		 * Other errors
+		 */
+		{
+			name: "Rejected on DATA",
+			cfg: codersdk.NotificationsEmailConfig{
+				Hello: hello,
+				From:  from,
+			},
+			failOnDataFn: func() error {
+				return &smtp.SMTPError{Code: 501, EnhancedCode: smtp.EnhancedCode{5, 5, 4}, Message: "Rejected!"}
+			},
+			expectedErr: "SMTP error 501: Rejected!",
+			retryable:   true,
+		},
 	}
 
 	// nolint:paralleltest // Reinitialization is not required as of Go v1.22.
@@ -398,6 +414,8 @@ func TestSMTP(t *testing.T) {
 				AcceptedIdentity: tc.cfg.Auth.Identity.String(),
 				AcceptedUsername: username,
 				AcceptedPassword: password,
+
+				FailOnDataFn: tc.failOnDataFn,
 			})
 
 			// Create a mock SMTP server which conditionally listens for plain or TLS connections.
diff --git a/coderd/notifications/dispatch/smtp_util_test.go b/coderd/notifications/dispatch/smtp_util_test.go
@@ -24,6 +24,7 @@ var (
 type Config struct {
 	AuthMechanisms                                       []string
 	AcceptedIdentity, AcceptedUsername, AcceptedPassword string
+	FailOnDataFn                                         func() error
 }
 
 type Message struct {
@@ -147,6 +148,10 @@ func (s *Session) Data(r io.Reader) error {
 		return err
 	}
 
+	if s.backend.cfg.FailOnDataFn != nil {
+		return s.backend.cfg.FailOnDataFn()
+	}
+
 	s.backend.lastMsg.Contents = string(b)
 
 	return nil

Original file line number	Diff line number	Diff line change
`@@ -183,7 +183,6 @@ func (s *SMTPHandler) dispatch(subject, htmlBody, plainBody, to string) Delivery`
`183`	`183`	`if err != nil {`
`184`	`184`	`return true, xerrors.Errorf("message transmission: %w", err)`
`185`	`185`	`}`
`186`		`- defer message.Close()`
`187`	`186`
`188`	`187`	`// Create message headers.`
`189`	`188`	`msg := &bytes.Buffer{}`
`@@ -251,6 +250,10 @@ func (s *SMTPHandler) dispatch(subject, htmlBody, plainBody, to string) Delivery`
`251`	`250`	`return false, xerrors.Errorf("write body buffer: %w", err)`
`252`	`251`	`}`
`253`	`252`
	`253`	`+ if err = message.Close(); err != nil {`
	`254`	`+ return true, xerrors.Errorf("delivery failure: %w", err)`
	`255`	`+ }`
	`256`	`+`
`254`	`257`	`// Returning false, nil indicates successful send (i.e. non-retryable non-error)`
`255`	`258`	`return false, nil`
`256`	`259`	`}`