chore: update error type name

DanielleMaywood · DanielleMaywood · commit c9df480302cb · 2025-03-25T17:52:58.000Z
diff --git a/coderd/notifications/enqueuer.go b/coderd/notifications/enqueuer.go
@@ -26,12 +26,12 @@ var (
 	ErrDuplicate                         = xerrors.New("duplicate notification")
 )
 
-type InvalidNotificationMethodError struct {
+type InvalidDefaultNotificationMethodError struct {
 	Method string
 }
 
-func (e InvalidNotificationMethodError) Error() string {
-	return fmt.Sprintf("given notification method %q is invalid", e.Method)
+func (e InvalidDefaultNotificationMethodError) Error() string {
+	return fmt.Sprintf("given default notification method %q is invalid", e.Method)
 }
 
 type StoreEnqueuer struct {
@@ -54,7 +54,7 @@ func NewStoreEnqueuer(cfg codersdk.NotificationsConfig, store Store, helpers tem
 	var method database.NotificationMethod
 	// We do not allow setting Coder Inbox as the default method.
 	if err := method.Scan(cfg.Method.String()); err != nil || method == database.NotificationMethodInbox {
-		return nil, InvalidNotificationMethodError{Method: cfg.Method.String()}
+		return nil, InvalidDefaultNotificationMethodError{Method: cfg.Method.String()}
 	}
 
 	return &StoreEnqueuer{
diff --git a/coderd/notifications/notifications_test.go b/coderd/notifications/notifications_test.go
@@ -1869,7 +1869,7 @@ func TestNotificationMethodCannotDefaultToInbox(t *testing.T) {
 	mClock.Set(time.Date(2024, 1, 15, 9, 0, 0, 0, time.UTC))
 
 	_, err := notifications.NewStoreEnqueuer(cfg, store, defaultHelpers(), logger.Named("enqueuer"), mClock)
-	require.ErrorIs(t, err, notifications.InvalidNotificationMethodError{Method: string(database.NotificationMethodInbox)})
+	require.ErrorIs(t, err, notifications.InvalidDefaultNotificationMethodError{Method: string(database.NotificationMethodInbox)})
 }
 
 func TestNotificationTargetMatrix(t *testing.T) {

Original file line number	Diff line number	Diff line change
`@@ -26,12 +26,12 @@ var (`
`26`	`26`	`ErrDuplicate = xerrors.New("duplicate notification")`
`27`	`27`	`)`
`28`	`28`
`29`		`-type InvalidNotificationMethodError struct {`
	`29`	`+type InvalidDefaultNotificationMethodError struct {`
`30`	`30`	`Method string`
`31`	`31`	`}`
`32`	`32`
`33`		`-func (e InvalidNotificationMethodError) Error() string {`
`34`		`- return fmt.Sprintf("given notification method %q is invalid", e.Method)`
	`33`	`+func (e InvalidDefaultNotificationMethodError) Error() string {`
	`34`	`+ return fmt.Sprintf("given default notification method %q is invalid", e.Method)`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`type StoreEnqueuer struct {`
`@@ -54,7 +54,7 @@ func NewStoreEnqueuer(cfg codersdk.NotificationsConfig, store Store, helpers tem`
`54`	`54`	`var method database.NotificationMethod`
`55`	`55`	`// We do not allow setting Coder Inbox as the default method.`
`56`	`56`	`if err := method.Scan(cfg.Method.String()); err != nil \|\| method == database.NotificationMethodInbox {`
`57`		`- return nil, InvalidNotificationMethodError{Method: cfg.Method.String()}`
	`57`	`+ return nil, InvalidDefaultNotificationMethodError{Method: cfg.Method.String()}`
`58`	`58`	`}`
`59`	`59`
`60`	`60`	`return &StoreEnqueuer{`
Original file line number	Diff line number	Diff line change
`@@ -1869,7 +1869,7 @@ func TestNotificationMethodCannotDefaultToInbox(t *testing.T) {`
`1869`	`1869`	`mClock.Set(time.Date(2024, 1, 15, 9, 0, 0, 0, time.UTC))`
`1870`	`1870`
`1871`	`1871`	`_, err := notifications.NewStoreEnqueuer(cfg, store, defaultHelpers(), logger.Named("enqueuer"), mClock)`
`1872`		`- require.ErrorIs(t, err, notifications.InvalidNotificationMethodError{Method: string(database.NotificationMethodInbox)})`
	`1872`	`+ require.ErrorIs(t, err, notifications.InvalidDefaultNotificationMethodError{Method: string(database.NotificationMethodInbox)})`
`1873`	`1873`	`}`
`1874`	`1874`
`1875`	`1875`	`func TestNotificationTargetMatrix(t *testing.T) {`