Fix conditional logging in key cache initialization

sreya · sreya · commit 692bb36025eb · 2024-10-20T19:08:40.000Z
Ensure that logging only occurs when an error is present during the initialization of the key caches. This prevents unnecessary log entries when no error is encountered, improving log clarity and reducing noise.
diff --git a/coderd/coderd.go b/coderd/coderd.go
@@ -462,7 +462,9 @@ func New(options *Options) *API {
 			fetcher,
 			codersdk.CryptoKeyFeatureOIDCConvert,
 		)
-		options.Logger.Critical(ctx, "failed to properly instantiate oidc convert signing cache", slog.Error(err))
+		if err != nil {
+			options.Logger.Critical(ctx, "failed to properly instantiate oidc convert signing cache", slog.Error(err))
+		}
 	}
 
 	if options.AppSigningKeyCache == nil {
@@ -471,7 +473,9 @@ func New(options *Options) *API {
 			fetcher,
 			codersdk.CryptoKeyFeatureWorkspaceAppsToken,
 		)
-		options.Logger.Critical(ctx, "failed to properly instantiate app signing key cache", slog.Error(err))
+		if err != nil {
+			options.Logger.Critical(ctx, "failed to properly instantiate app signing key cache", slog.Error(err))
+		}
 	}
 
 	if options.AppEncryptionKeyCache == nil {
@@ -480,7 +484,9 @@ func New(options *Options) *API {
 			fetcher,
 			codersdk.CryptoKeyFeatureWorkspaceAppsAPIKey,
 		)
-		options.Logger.Critical(ctx, "failed to properly instantiate app encryption key cache", slog.Error(err))
+		if err != nil {
+			options.Logger.Critical(ctx, "failed to properly instantiate app encryption key cache", slog.Error(err))
+		}
 	}
 
 	// Start a background process that rotates keys. We intentionally start this after the caches
diff --git a/coderd/workspaceapps_test.go b/coderd/workspaceapps_test.go
@@ -7,10 +7,11 @@ import (
 	"testing"
 	"time"
 
-	"cdr.dev/slog/sloggers/slogtest"
 	"github.com/go-jose/go-jose/v4/jwt"
 	"github.com/stretchr/testify/require"
 
+	"cdr.dev/slog/sloggers/slogtest"
+
 	"github.com/coder/coder/v2/coderd/coderdtest"
 	"github.com/coder/coder/v2/coderd/cryptokeys"
 	"github.com/coder/coder/v2/coderd/database"

Original file line number	Diff line number	Diff line change
`@@ -462,7 +462,9 @@ func New(options Options) API {`
`462`	`462`	`fetcher,`
`463`	`463`	`codersdk.CryptoKeyFeatureOIDCConvert,`
`464`	`464`	`)`
`465`		`- options.Logger.Critical(ctx, "failed to properly instantiate oidc convert signing cache", slog.Error(err))`
	`465`	`+ if err != nil {`
	`466`	`+ options.Logger.Critical(ctx, "failed to properly instantiate oidc convert signing cache", slog.Error(err))`
	`467`	`+ }`
`466`	`468`	`}`
`467`	`469`
`468`	`470`	`if options.AppSigningKeyCache == nil {`
`@@ -471,7 +473,9 @@ func New(options Options) API {`
`471`	`473`	`fetcher,`
`472`	`474`	`codersdk.CryptoKeyFeatureWorkspaceAppsToken,`
`473`	`475`	`)`
`474`		`- options.Logger.Critical(ctx, "failed to properly instantiate app signing key cache", slog.Error(err))`
	`476`	`+ if err != nil {`
	`477`	`+ options.Logger.Critical(ctx, "failed to properly instantiate app signing key cache", slog.Error(err))`
	`478`	`+ }`
`475`	`479`	`}`
`476`	`480`
`477`	`481`	`if options.AppEncryptionKeyCache == nil {`
`@@ -480,7 +484,9 @@ func New(options Options) API {`
`480`	`484`	`fetcher,`
`481`	`485`	`codersdk.CryptoKeyFeatureWorkspaceAppsAPIKey,`
`482`	`486`	`)`
`483`		`- options.Logger.Critical(ctx, "failed to properly instantiate app encryption key cache", slog.Error(err))`
	`487`	`+ if err != nil {`
	`488`	`+ options.Logger.Critical(ctx, "failed to properly instantiate app encryption key cache", slog.Error(err))`
	`489`	`+ }`
`484`	`490`	`}`
`485`	`491`
`486`	`492`	`// Start a background process that rotates keys. We intentionally start this after the caches`