fix: stop logging errors on cancel in notifier (#15186)

spikecurtis · web-flow · commit d9f1aafa94f7 · 2024-10-25T16:28:54.000+04:00
fixes coder/internal#121 We shouldn't log errors when context is canceled, e.g. on shutdown. This breaks our tests and alarms customers needlessly.
diff --git a/coderd/notifications/fetcher.go b/coderd/notifications/fetcher.go
@@ -7,19 +7,15 @@ import (
 	"text/template"
 
 	"golang.org/x/xerrors"
-
-	"cdr.dev/slog"
 )
 
 func (n *notifier) fetchHelpers(ctx context.Context) (map[string]any, error) {
 	appName, err := n.fetchAppName(ctx)
 	if err != nil {
-		n.log.Error(ctx, "failed to fetch app name", slog.Error(err))
 		return nil, xerrors.Errorf("fetch app name: %w", err)
 	}
 	logoURL, err := n.fetchLogoURL(ctx)
 	if err != nil {
-		n.log.Error(ctx, "failed to fetch logo URL", slog.Error(err))
 		return nil, xerrors.Errorf("fetch logo URL: %w", err)
 	}
 
diff --git a/coderd/notifications/notifier.go b/coderd/notifications/notifier.go
@@ -3,6 +3,7 @@ package notifications
 import (
 	"context"
 	"encoding/json"
+	"fmt"
 	"sync"
 	"text/template"
 
@@ -27,7 +28,22 @@ const (
 	notificationsDefaultAppName = "Coder"
 )
 
-var errDecorateHelpersFailed = xerrors.New("failed to decorate helpers")
+type decorateHelpersError struct {
+	inner error
+}
+
+func (e decorateHelpersError) Error() string {
+	return fmt.Sprintf("failed to decorate helpers: %s", e.inner.Error())
+}
+
+func (e decorateHelpersError) Unwrap() error {
+	return e.inner
+}
+
+func (decorateHelpersError) Is(other error) bool {
+	_, ok := other.(decorateHelpersError)
+	return ok
+}
 
 // notifier is a consumer of the notifications_messages queue. It dequeues messages from that table and processes them
 // through a pipeline of fetch -> prepare -> render -> acquire handler -> deliver.
@@ -164,8 +180,12 @@ func (n *notifier) process(ctx context.Context, success chan<- dispatchResult, f
 		// A message failing to be prepared correctly should not affect other messages.
 		deliverFn, err := n.prepare(ctx, msg)
 		if err != nil {
-			n.log.Warn(ctx, "dispatcher construction failed", slog.F("msg_id", msg.ID), slog.Error(err))
-			failure <- n.newFailedDispatch(msg, err, xerrors.Is(err, errDecorateHelpersFailed))
+			if database.IsQueryCanceledError(err) {
+				n.log.Debug(ctx, "dispatcher construction canceled", slog.F("msg_id", msg.ID), slog.Error(err))
+			} else {
+				n.log.Error(ctx, "dispatcher construction failed", slog.F("msg_id", msg.ID), slog.Error(err))
+			}
+			failure <- n.newFailedDispatch(msg, err, xerrors.Is(err, decorateHelpersError{}))
 			n.metrics.PendingUpdates.Set(float64(len(success) + len(failure)))
 			continue
 		}
@@ -226,7 +246,7 @@ func (n *notifier) prepare(ctx context.Context, msg database.AcquireNotification
 
 	helpers, err := n.fetchHelpers(ctx)
 	if err != nil {
-		return nil, errDecorateHelpersFailed
+		return nil, decorateHelpersError{err}
 	}
 
 	var title, body string

Original file line number	Diff line number	Diff line change
`@@ -7,19 +7,15 @@ import (`
`7`	`7`	`"text/template"`
`8`	`8`
`9`	`9`	`"golang.org/x/xerrors"`
`10`		`-`
`11`		`- "cdr.dev/slog"`
`12`	`10`	`)`
`13`	`11`
`14`	`12`	`func (n *notifier) fetchHelpers(ctx context.Context) (map[string]any, error) {`
`15`	`13`	`appName, err := n.fetchAppName(ctx)`
`16`	`14`	`if err != nil {`
`17`		`- n.log.Error(ctx, "failed to fetch app name", slog.Error(err))`
`18`	`15`	`return nil, xerrors.Errorf("fetch app name: %w", err)`
`19`	`16`	`}`
`20`	`17`	`logoURL, err := n.fetchLogoURL(ctx)`
`21`	`18`	`if err != nil {`
`22`		`- n.log.Error(ctx, "failed to fetch logo URL", slog.Error(err))`
`23`	`19`	`return nil, xerrors.Errorf("fetch logo URL: %w", err)`
`24`	`20`	`}`
`25`	`21`