Refactor to use nfydest package for destination types

- Replaced type definitions with nfydest equivalents
- Updated type info and validation methods
- Aligned dynamic parameters and fields with new interfaces
- Adjusted imports and model mappings in graphql schema

graphql2/gqlgen.yml

@@ -138,3 +138,9 @@ models:
     model: github.com/target/goalert/gadb.UIKRuleV1
   KeyConfig:
     model: github.com/target/goalert/gadb.UIKConfigV1
+  DestinationFieldConfig:
+    model: github.com/target/goalert/notification/nfydest.FieldConfig
+  DestinationTypeInfo:
+    model: github.com/target/goalert/notification/nfydest.TypeInfo
+  DynamicParamConfig:
+    model: github.com/target/goalert/notification/nfydest.DynamicParamConfig

graphql2/graphqlapp/destinationtypes.go

@@ -7,6 +7,7 @@ import (
 	"github.com/nyaruka/phonenumbers"
 	"github.com/target/goalert/config"
 	"github.com/target/goalert/graphql2"
+	"github.com/target/goalert/notification/nfydest"
 	"github.com/target/goalert/validation"
 	"github.com/target/goalert/validation/validate"
 )
@@ -246,15 +247,15 @@ func (q *Query) DestinationFieldValidate(ctx context.Context, input graphql2.Des
 	return false, validation.NewGenericError("unsupported data type")
 }
 
-func (q *Query) DestinationTypes(ctx context.Context, isDynamicAction *bool) ([]graphql2.DestinationTypeInfo, error) {
+func (q *Query) DestinationTypes(ctx context.Context, isDynamicAction *bool) ([]nfydest.TypeInfo, error) {
 	cfg := config.FromContext(ctx)
-	types := []graphql2.DestinationTypeInfo{
+	types := []nfydest.TypeInfo{
 		{
 			Type:            destAlert,
 			Name:            "Alert",
 			Enabled:         true,
-			IsDynamicAction: true,
-			DynamicParams: []graphql2.DynamicParamConfig{{
+			SupportsSignals: true,
+			DynamicParams: []nfydest.DynamicParamConfig{{
 				ParamID: "summary",
 				Label:   "Summary",
 				Hint:    "Short summary of the alert (used for things like SMS).",
@@ -273,13 +274,15 @@ func (q *Query) DestinationTypes(ctx context.Context, isDynamicAction *bool) ([]
 			}},
 		},
 		{
-			Type:                  destTwilioSMS,
-			Name:                  "Text Message (SMS)",
-			Enabled:               cfg.Twilio.Enable,
-			UserDisclaimer:        cfg.General.NotificationDisclaimer,
-			SupportsStatusUpdates: true,
-			IsContactMethod:       true,
-			RequiredFields: []graphql2.DestinationFieldConfig{{
+			Type:                       destTwilioSMS,
+			Name:                       "Text Message (SMS)",
+			Enabled:                    cfg.Twilio.Enable,
+			UserDisclaimer:             cfg.General.NotificationDisclaimer,
+			SupportsAlertNotifications: true,
+			SupportsUserVerification:   true,
+			SupportsStatusUpdates:      true,
+			UserVerificationRequired:   true,
+			RequiredFields: []nfydest.FieldConfig{{
 				FieldID:            fieldPhoneNumber,
 				Label:              "Phone Number",
 				Hint:               "Include country code e.g. +1 (USA), +91 (India), +44 (UK)",
@@ -290,13 +293,15 @@ func (q *Query) DestinationTypes(ctx context.Context, isDynamicAction *bool) ([]
 			}},
 		},
 		{
-			Type:                  destTwilioVoice,
-			Name:                  "Voice Call",
-			Enabled:               cfg.Twilio.Enable,
-			UserDisclaimer:        cfg.General.NotificationDisclaimer,
-			IsContactMethod:       true,
-			SupportsStatusUpdates: true,
-			RequiredFields: []graphql2.DestinationFieldConfig{{
+			Type:                       destTwilioVoice,
+			Name:                       "Voice Call",
+			Enabled:                    cfg.Twilio.Enable,
+			UserDisclaimer:             cfg.General.NotificationDisclaimer,
+			SupportsAlertNotifications: true,
+			SupportsUserVerification:   true,
+			SupportsStatusUpdates:      true,
+			UserVerificationRequired:   true,
+			RequiredFields: []nfydest.FieldConfig{{
 				FieldID:            fieldPhoneNumber,
 				Label:              "Phone Number",
 				Hint:               "Include country code e.g. +1 (USA), +91 (India), +44 (UK)",
@@ -307,20 +312,21 @@ func (q *Query) DestinationTypes(ctx context.Context, isDynamicAction *bool) ([]
 			}},
 		},
 		{
-			Type:                  destSMTP,
-			Name:                  "Email",
-			Enabled:               cfg.SMTP.Enable,
-			IsContactMethod:       true,
-			SupportsStatusUpdates: true,
-			IsDynamicAction:       false,
-			RequiredFields: []graphql2.DestinationFieldConfig{{
+			Type:                       destSMTP,
+			Name:                       "Email",
+			Enabled:                    cfg.SMTP.Enable,
+			SupportsAlertNotifications: true,
+			SupportsUserVerification:   true,
+			SupportsStatusUpdates:      true,
+			UserVerificationRequired:   true,
+			RequiredFields: []nfydest.FieldConfig{{
 				FieldID:            fieldEmailAddress,
 				Label:              "Email Address",
 				PlaceholderText:    "foobar@example.com",
 				InputType:          "email",
 				SupportsValidation: true,
 			}},
-			DynamicParams: []graphql2.DynamicParamConfig{{
+			DynamicParams: []nfydest.DynamicParamConfig{{
 				ParamID: "subject",
 				Label:   "Subject",
 				Hint:    "Subject of the email message.",
@@ -331,15 +337,16 @@ func (q *Query) DestinationTypes(ctx context.Context, isDynamicAction *bool) ([]
 			}},
 		},
 		{
-			Type:                  destWebhook,
-			Name:                  "Webhook",
-			Enabled:               cfg.Webhook.Enable,
-			IsContactMethod:       true,
-			IsEPTarget:            true,
-			IsSchedOnCallNotify:   true,
-			SupportsStatusUpdates: true,
-			StatusUpdatesRequired: true,
-			RequiredFields: []graphql2.DestinationFieldConfig{{
+			Type:                       destWebhook,
+			Name:                       "Webhook",
+			Enabled:                    cfg.Webhook.Enable,
+			SupportsUserVerification:   true,
+			SupportsOnCallNotify:       true,
+			SupportsSignals:            true,
+			SupportsStatusUpdates:      true,
+			SupportsAlertNotifications: true,
+			StatusUpdatesRequired:      true,
+			RequiredFields: []nfydest.FieldConfig{{
 				FieldID:            fieldWebhookURL,
 				Label:              "Webhook URL",
 				PlaceholderText:    "https://example.com",
@@ -348,8 +355,7 @@ func (q *Query) DestinationTypes(ctx context.Context, isDynamicAction *bool) ([]
 				HintURL:            "/docs#webhooks",
 				SupportsValidation: true,
 			}},
-			IsDynamicAction: true,
-			DynamicParams: []graphql2.DynamicParamConfig{
+			DynamicParams: []nfydest.DynamicParamConfig{
 				{
 					ParamID: "body",
 					Label:   "Body",
@@ -364,13 +370,15 @@ func (q *Query) DestinationTypes(ctx context.Context, isDynamicAction *bool) ([]
 			},
 		},
 		{
-			Type:                  destSlackDM,
-			Name:                  "Slack Message (DM)",
-			Enabled:               cfg.Slack.Enable,
-			IsContactMethod:       true,
-			SupportsStatusUpdates: true,
-			StatusUpdatesRequired: true,
-			RequiredFields: []graphql2.DestinationFieldConfig{{
+			Type:                       destSlackDM,
+			Name:                       "Slack Message (DM)",
+			Enabled:                    cfg.Slack.Enable,
+			SupportsAlertNotifications: true,
+			SupportsUserVerification:   true,
+			SupportsStatusUpdates:      true,
+			UserVerificationRequired:   true,
+			StatusUpdatesRequired:      true,
+			RequiredFields: []nfydest.FieldConfig{{
 				FieldID:         fieldSlackUserID,
 				Label:           "Slack User",
 				PlaceholderText: "member ID",
@@ -380,32 +388,31 @@ func (q *Query) DestinationTypes(ctx context.Context, isDynamicAction *bool) ([]
 			}},
 		},
 		{
-			Type:                  destSlackChan,
-			Name:                  "Slack Channel",
-			Enabled:               cfg.Slack.Enable,
-			IsEPTarget:            true,
-			IsSchedOnCallNotify:   true,
-			IsDynamicAction:       true,
-			SupportsStatusUpdates: true,
-			StatusUpdatesRequired: true,
-			RequiredFields: []graphql2.DestinationFieldConfig{{
+			Type:                       destSlackChan,
+			Name:                       "Slack Channel",
+			Enabled:                    cfg.Slack.Enable,
+			SupportsAlertNotifications: true,
+			SupportsStatusUpdates:      true,
+			SupportsOnCallNotify:       true,
+			StatusUpdatesRequired:      true,
+			RequiredFields: []nfydest.FieldConfig{{
 				FieldID:        fieldSlackChanID,
 				Label:          "Slack Channel",
 				InputType:      "text",
 				SupportsSearch: true,
 			}},
-			DynamicParams: []graphql2.DynamicParamConfig{{
+			DynamicParams: []nfydest.DynamicParamConfig{{
 				ParamID: "message",
 				Label:   "Message",
 				Hint:    "The text of the message to send.",
 			}},
 		},
 		{
-			Type:                destSlackUG,
-			Name:                "Update Slack User Group",
-			Enabled:             cfg.Slack.Enable,
-			IsSchedOnCallNotify: true,
-			RequiredFields: []graphql2.DestinationFieldConfig{{
+			Type:                 destSlackUG,
+			Name:                 "Update Slack User Group",
+			Enabled:              cfg.Slack.Enable,
+			SupportsOnCallNotify: true,
+			RequiredFields: []nfydest.FieldConfig{{
 				FieldID:        fieldSlackUGID,
 				Label:          "User Group",
 				InputType:      "text",
@@ -420,35 +427,35 @@ func (q *Query) DestinationTypes(ctx context.Context, isDynamicAction *bool) ([]
 			}},
 		},
 		{
-			Type:       destRotation,
-			Name:       "Rotation",
-			Enabled:    true,
-			IsEPTarget: true,
-			RequiredFields: []graphql2.DestinationFieldConfig{{
+			Type:                       destRotation,
+			Name:                       "Rotation",
+			Enabled:                    true,
+			SupportsAlertNotifications: true,
+			RequiredFields: []nfydest.FieldConfig{{
 				FieldID:        fieldRotationID,
 				Label:          "Rotation",
 				InputType:      "text",
 				SupportsSearch: true,
 			}},
 		},
 		{
-			Type:       destSchedule,
-			Name:       "Schedule",
-			Enabled:    true,
-			IsEPTarget: true,
-			RequiredFields: []graphql2.DestinationFieldConfig{{
+			Type:                       destSchedule,
+			Name:                       "Schedule",
+			Enabled:                    true,
+			SupportsAlertNotifications: true,
+			RequiredFields: []nfydest.FieldConfig{{
 				FieldID:        fieldScheduleID,
 				Label:          "Schedule",
 				InputType:      "text",
 				SupportsSearch: true,
 			}},
 		},
 		{
-			Type:       destUser,
-			Name:       "User",
-			Enabled:    true,
-			IsEPTarget: true,
-			RequiredFields: []graphql2.DestinationFieldConfig{{
+			Type:                       destUser,
+			Name:                       "User",
+			Enabled:                    true,
+			SupportsAlertNotifications: true,
+			RequiredFields: []nfydest.FieldConfig{{
 				FieldID:        fieldUserID,
 				Label:          "User",
 				InputType:      "text",
@@ -457,7 +464,7 @@ func (q *Query) DestinationTypes(ctx context.Context, isDynamicAction *bool) ([]
 		},
 	}
 
-	slices.SortStableFunc(types, func(a, b graphql2.DestinationTypeInfo) int {
+	slices.SortStableFunc(types, func(a, b nfydest.TypeInfo) int {
 		if a.Enabled && !b.Enabled {
 			return -1
 		}
@@ -471,7 +478,7 @@ func (q *Query) DestinationTypes(ctx context.Context, isDynamicAction *bool) ([]
 
 	filtered := types[:0]
 	for _, t := range types {
-		if isDynamicAction != nil && *isDynamicAction != t.IsDynamicAction {
+		if isDynamicAction != nil && *isDynamicAction != t.IsDynamicAction() {
 			continue
 		}
 

notification/nfydest/provider.go

@@ -0,0 +1,42 @@
+package nfydest
+
+import "context"
+
+type Provider interface {
+	ID() string
+	TypeInfo(ctx context.Context) (*TypeInfo, error)
+
+	ValidateField(ctx context.Context, fieldID, value string) (ok bool, err error)
+	DisplayInfo(ctx context.Context, args map[string]string) (*DisplayInfo, error)
+}
+
+type DisplayInfo struct {
+	Text        string
+	IconURL     string
+	IconAltText string
+	LinkURL     string
+}
+
+type SearchOptions struct {
+	Search string
+	Omit   []string
+	Cursor string
+	Limit  int
+}
+
+type SearchResult struct {
+	HasNextPage bool
+	Cursor      string
+	Values      []FieldValue
+}
+
+type FieldValue struct {
+	Value      string
+	Label      string
+	IsFavorite bool
+}
+
+type FieldSearcher interface {
+	SearchField(ctx context.Context, fieldID string, options SearchOptions) (*SearchResult, error)
+	FieldLabel(ctx context.Context, fieldID, value string) (string, error)
+}

notification/nfydest/typeinfo.go

@@ -0,0 +1,61 @@
+package nfydest
+
+type TypeInfo struct {
+	Type string
+
+	Name        string
+	IconURL     string
+	IconAltText string
+	Enabled     bool
+
+	RequiredFields []FieldConfig
+	DynamicParams  []DynamicParamConfig
+
+	UserDisclaimer string
+
+	// Message type info
+	SupportsStatusUpdates      bool
+	SupportsAlertNotifications bool
+	SupportsUserVerification   bool
+	SupportsOnCallNotify       bool
+	SupportsSignals            bool
+
+	UserVerificationRequired bool
+	StatusUpdatesRequired    bool
+}
+
+func (t TypeInfo) IsContactMethod() bool {
+	return t.SupportsAlertNotifications && t.SupportsUserVerification
+}
+
+func (t TypeInfo) IsEPTarget() bool {
+	return t.SupportsAlertNotifications && !t.UserVerificationRequired
+}
+
+func (t TypeInfo) IsSchedOnCallNotify() bool {
+	return t.SupportsOnCallNotify && !t.UserVerificationRequired
+}
+
+func (t TypeInfo) IsDynamicAction() bool {
+	return t.SupportsSignals && !t.UserVerificationRequired
+}
+
+type FieldConfig struct {
+	FieldID            string
+	Label              string
+	Hint               string
+	HintURL            string
+	PlaceholderText    string
+	Prefix             string
+	InputType          string
+	SupportsSearch     bool
+	SupportsValidation bool
+}
+
+type DynamicParamConfig struct {
+	ParamID      string
+	Label        string
+	Hint         string
+	HintURL      string
+	DefaultValue string
+}