dest/graphql: normalize schema fields (#3703)

* convert comments to description strings * fix missing text on label * update label and search select fields * update UI for schema changes
target · Feb 23, 2024 · ee523ba · ee523ba
1 parent 91fc3a7
commit ee523ba
Show file tree

Hide file tree

Showing 12 changed files with 94 additions and 186 deletions.
diff --git a/graphql2/generated.go b/graphql2/generated.go
diff --git a/graphql2/graph/destinations.graphqls b/graphql2/graph/destinations.graphqls
@@ -219,14 +219,9 @@ type DestinationFieldConfig {
   fieldID: ID!
 
   """
-  user-friendly label
+  user-friendly label (should be singular)
   """
-  labelSingular: String!
-
-  """
-  user-friendly plural label
-  """
-  labelPlural: String!
+  label: String!
 
   """
   user-friendly helper text for input fields (i.e., "Enter a phone number")
@@ -256,7 +251,7 @@ type DestinationFieldConfig {
   """
   if true, the destination can be selected via search
   """
-  isSearchSelectable: Boolean!
+  supportsSearch: Boolean!
 
   """
   if true, the destination type supports validation

diff --git a/graphql2/graphqlapp/destinationtypes.go b/graphql2/graphqlapp/destinationtypes.go
@@ -301,8 +301,7 @@ func (q *Query) DestinationTypes(ctx context.Context) ([]graphql2.DestinationTyp
 			IsContactMethod:       true,
 			RequiredFields: []graphql2.DestinationFieldConfig{{
 				FieldID:            fieldPhoneNumber,
-				LabelSingular:      "Phone Number",
-				LabelPlural:        "Phone Numbers",
+				Label:              "Phone Number",
 				Hint:               "Include country code e.g. +1 (USA), +91 (India), +44 (UK)",
 				PlaceholderText:    "11235550123",
 				Prefix:             "+",
@@ -320,8 +319,7 @@ func (q *Query) DestinationTypes(ctx context.Context) ([]graphql2.DestinationTyp
 			SupportsStatusUpdates: true,
 			RequiredFields: []graphql2.DestinationFieldConfig{{
 				FieldID:            fieldPhoneNumber,
-				LabelSingular:      "Phone Number",
-				LabelPlural:        "Phone Numbers",
+				Label:              "Phone Number",
 				Hint:               "Include country code e.g. +1 (USA), +91 (India), +44 (UK)",
 				PlaceholderText:    "11235550123",
 				Prefix:             "+",
@@ -338,8 +336,7 @@ func (q *Query) DestinationTypes(ctx context.Context) ([]graphql2.DestinationTyp
 			DisabledMessage:       "SMTP must be configured by an administrator",
 			RequiredFields: []graphql2.DestinationFieldConfig{{
 				FieldID:            fieldEmailAddress,
-				LabelSingular:      "Email Address",
-				LabelPlural:        "Email Addresses",
+				Label:              "Email Address",
 				PlaceholderText:    "foobar@example.com",
 				InputType:          "email",
 				SupportsValidation: true,
@@ -357,8 +354,7 @@ func (q *Query) DestinationTypes(ctx context.Context) ([]graphql2.DestinationTyp
 			DisabledMessage:       "Webhooks must be enabled by an administrator",
 			RequiredFields: []graphql2.DestinationFieldConfig{{
 				FieldID:            fieldWebhookURL,
-				LabelSingular:      "Webhook URL",
-				LabelPlural:        "Webhook URLs",
+				Label:              "Webhook URL",
 				PlaceholderText:    "https://example.com",
 				InputType:          "url",
 				Hint:               "Webhook Documentation",
@@ -376,11 +372,10 @@ func (q *Query) DestinationTypes(ctx context.Context) ([]graphql2.DestinationTyp
 			DisabledMessage:       "Slack must be enabled by an administrator",
 			RequiredFields: []graphql2.DestinationFieldConfig{{
 				FieldID:         fieldSlackUserID,
-				LabelSingular:   "Slack User",
-				LabelPlural:     "Slack Users",
+				Label:           "Slack User",
 				PlaceholderText: "member ID",
 				InputType:       "text",
-				// IsSearchSelectable: true, // TODO: implement search select functionality for users
+				// supportsSearch: true, // TODO: implement search select functionality for users
 				Hint: `Go to your Slack profile, click the three dots, and select "Copy member ID".`,
 			}},
 		},
@@ -394,11 +389,10 @@ func (q *Query) DestinationTypes(ctx context.Context) ([]graphql2.DestinationTyp
 			StatusUpdatesRequired: true,
 			DisabledMessage:       "Slack must be enabled by an administrator",
 			RequiredFields: []graphql2.DestinationFieldConfig{{
-				FieldID:            fieldSlackChanID,
-				LabelSingular:      "Slack Channel",
-				LabelPlural:        "Slack Channels",
-				InputType:          "text",
-				IsSearchSelectable: true,
+				FieldID:        fieldSlackChanID,
+				Label:          "Slack Channel",
+				InputType:      "text",
+				SupportsSearch: true,
 			}},
 		},
 		{
@@ -408,19 +402,17 @@ func (q *Query) DestinationTypes(ctx context.Context) ([]graphql2.DestinationTyp
 			IsSchedOnCallNotify: true,
 			DisabledMessage:     "Slack must be enabled by an administrator",
 			RequiredFields: []graphql2.DestinationFieldConfig{{
-				FieldID:            fieldSlackUGID,
-				LabelSingular:      "User Group",
-				LabelPlural:        "User Groups",
-				InputType:          "text",
-				IsSearchSelectable: true,
-				Hint:               "The selected group's membership will be replaced/set to the schedule's on-call user(s).",
+				FieldID:        fieldSlackUGID,
+				Label:          "User Group",
+				InputType:      "text",
+				SupportsSearch: true,
+				Hint:           "The selected group's membership will be replaced/set to the schedule's on-call user(s).",
 			}, {
-				FieldID:            fieldSlackChanID,
-				LabelSingular:      "Slack Channel (for errors)",
-				LabelPlural:        "Slack Channels (for errors)",
-				InputType:          "text",
-				IsSearchSelectable: true,
-				Hint:               "If the user group update fails, an error will be posted to this channel.",
+				FieldID:        fieldSlackChanID,
+				Label:          "Slack Channel (for errors)",
+				InputType:      "text",
+				SupportsSearch: true,
+				Hint:           "If the user group update fails, an error will be posted to this channel.",
 			}},
 		},
 		{

diff --git a/graphql2/models_gen.go b/graphql2/models_gen.go
diff --git a/web/src/app/selection/DestinationField.tsx b/web/src/app/selection/DestinationField.tsx
@@ -52,7 +52,7 @@ export default function DestinationField(
           )?.message || '',
         )
 
-        if (field.isSearchSelectable)
+        if (field.supportsSearch)
           return (
             <Grid key={field.fieldID} item xs={12} sm={12} md={12}>
               <DestinationSearchSelect