add type universal to integration keys (#3836)

* add universal type to integration keys * make generate * make db-schema * make check * add exp flag checks * revert hardcoded UI int key type * update universal key label Co-authored-by: Nathaniel Caza <mastercactapus@gmail.com> * update exp flag check for universal keys Co-authored-by: Nathaniel Caza <mastercactapus@gmail.com> * add import * make check --------- Co-authored-by: Nathaniel Caza <mastercactapus@gmail.com>
target · May 3, 2024 · ddd62b0 · ddd62b0
1 parent a1268f4
commit ddd62b0
Show file tree

Hide file tree

Showing 13 changed files with 44 additions and 11 deletions.
diff --git a/alert/alert.go b/alert/alert.go
@@ -61,7 +61,7 @@ func (a Alert) Normalize() (*Alert, error) {
 	err := validate.Many(
 		validate.Text("Summary", a.Summary, 1, MaxSummaryLength),
 		validate.Text("Details", a.Details, 0, MaxDetailsLength),
-		validate.OneOf("Source", a.Source, SourceManual, SourceGrafana, SourceSite24x7, SourcePrometheusAlertmanager, SourceEmail, SourceGeneric),
+		validate.OneOf("Source", a.Source, SourceManual, SourceGrafana, SourceSite24x7, SourcePrometheusAlertmanager, SourceEmail, SourceGeneric, SourceUniversal),
 		validate.OneOf("Status", a.Status, StatusTriggered, StatusActive, StatusClosed),
 		validate.UUID("ServiceID", a.ServiceID),
 	)

diff --git a/alert/alertlog/legacylogs.go b/alert/alertlog/legacylogs.go
@@ -107,6 +107,8 @@ func createdSubject(msg string) *Subject {
 		return &Subject{Type: SubjectTypeUser, Classifier: "Web"}
 	case "Created via: generic":
 		return &Subject{Type: SubjectTypeIntegrationKey, Classifier: "Generic"}
+	case "Created via: universal":
+		return &Subject{Type: SubjectTypeIntegrationKey, Classifier: "Universal"}
 	}
 	return nil
 }
diff --git a/alert/source.go b/alert/source.go
@@ -16,6 +16,7 @@ const (
 	SourcePrometheusAlertmanager Source = "prometheusAlertmanager" // prometheus alertmanager alert
 	SourceManual                 Source = "manual"                 // manually triggered
 	SourceGeneric                Source = "generic"                // generic API
+	SourceUniversal              Source = "universal"              // universal integration
 )
 
 func (s Source) Value() (driver.Value, error) {

diff --git a/gadb/models.go b/gadb/models.go
diff --git a/go.mod b/go.mod
@@ -1,6 +1,6 @@
 module github.com/target/goalert
 
-go 1.22.0
+go 1.22
 
 require (
 	github.com/99designs/gqlgen v0.17.45

diff --git a/graphql2/graphqlapp/config.go b/graphql2/graphqlapp/config.go
@@ -4,19 +4,26 @@ import (
 	"context"
 
 	"github.com/target/goalert/config"
+	"github.com/target/goalert/expflag"
 	"github.com/target/goalert/graphql2"
 	"github.com/target/goalert/permission"
 )
 
 func (a *Query) IntegrationKeyTypes(ctx context.Context) ([]graphql2.IntegrationKeyTypeInfo, error) {
 	cfg := config.FromContext(ctx)
-	return []graphql2.IntegrationKeyTypeInfo{
+	typeInfo := []graphql2.IntegrationKeyTypeInfo{
 		{ID: "email", Name: "Email", Label: "Email Address", Enabled: cfg.EmailIngressEnabled()},
 		{ID: "generic", Name: "Generic API", Label: "Generic Webhook URL", Enabled: true},
 		{ID: "grafana", Name: "Grafana", Label: "Grafana Webhook URL", Enabled: true},
 		{ID: "site24x7", Name: "Site 24x7", Label: "Site24x7 Webhook URL", Enabled: true},
 		{ID: "prometheusAlertmanager", Label: "Alertmanager Webhook URL", Name: "Prometheus Alertmanager", Enabled: true},
-	}, nil
+	}
+
+	if expflag.ContextHas(ctx, expflag.UnivKeys) {
+		typeInfo = append(typeInfo, graphql2.IntegrationKeyTypeInfo{ID: "universal", Label: "Universal Integration Key URL", Name: "Universal Integration Key", Enabled: true})
+	}
+
+	return typeInfo, nil
 }
 
 func (q *Query) Config(ctx context.Context, all *bool) ([]graphql2.ConfigValue, error) {

diff --git a/graphql2/models_gen.go b/graphql2/models_gen.go
diff --git a/graphql2/schema.graphql b/graphql2/schema.graphql
@@ -1052,6 +1052,7 @@ enum IntegrationKeyType {
   site24x7
   prometheusAlertmanager
   email
+  universal
 }
 
 type ServiceOnCallUser {

diff --git a/integrationkey/store.go b/integrationkey/store.go
@@ -5,8 +5,10 @@ import (
 	"database/sql"
 
 	"github.com/target/goalert/auth/authtoken"
+	"github.com/target/goalert/expflag"
 	"github.com/target/goalert/gadb"
 	"github.com/target/goalert/permission"
+	"github.com/target/goalert/validation"
 	"github.com/target/goalert/validation/validate"
 
 	"github.com/google/uuid"
@@ -44,7 +46,7 @@ func (s *Store) GetServiceID(ctx context.Context, id string, t Type) (string, er
 	keyUUID, err := validate.ParseUUID("IntegrationKeyID", id)
 	err = validate.Many(
 		err,
-		validate.OneOf("IntegrationType", t, TypeGrafana, TypeSite24x7, TypePrometheusAlertmanager, TypeGeneric, TypeEmail),
+		validate.OneOf("IntegrationType", t, TypeGrafana, TypeSite24x7, TypePrometheusAlertmanager, TypeGeneric, TypeEmail, TypeUniversal),
 	)
 	if err != nil {
 		return "", err
@@ -80,6 +82,10 @@ func (s *Store) Create(ctx context.Context, dbtx gadb.DBTX, i *IntegrationKey) (
 		return nil, err
 	}
 
+	if i.Type == TypeUniversal && !expflag.ContextHas(ctx, expflag.UnivKeys) {
+		return nil, validation.NewGenericError("experimental flag not enabled")
+	}
+
 	serviceUUID, err := uuid.Parse(n.ServiceID)
 	if err != nil {
 		return nil, err

diff --git a/integrationkey/type.go b/integrationkey/type.go
@@ -15,6 +15,7 @@ const (
 	TypePrometheusAlertmanager Type = "prometheusAlertmanager"
 	TypeGeneric                Type = "generic"
 	TypeEmail                  Type = "email"
+	TypeUniversal              Type = "universal"
 )
 
 func (s Type) Value() (driver.Value, error) {

diff --git a/migrate/migrations/20240502114803-universal-integration-key.sql b/migrate/migrations/20240502114803-universal-integration-key.sql
@@ -0,0 +1,8 @@
+-- +migrate Up notransaction
+ALTER TYPE enum_integration_keys_type
+  ADD VALUE IF NOT EXISTS 'universal';
+
+ALTER TYPE enum_alert_source
+  ADD VALUE IF NOT EXISTS 'universal';
+
+-- +migrate Down
diff --git a/migrate/schema.sql b/migrate/schema.sql
@@ -1,7 +1,7 @@
 -- This file is auto-generated by "make db-schema"; DO NOT EDIT
--- DATA=596edde315555fde9765e0aa166955c2d44ec2c24263bc4a46d4a94506d9c8db  -
--- DISK=b269e94400bcbfc12246e820bfb30250f47a6b435092af08d9ff5a00fe7abcd8  -
--- PSQL=b269e94400bcbfc12246e820bfb30250f47a6b435092af08d9ff5a00fe7abcd8  -
+-- DATA=7d93d4f1913d4f571b975bbb160ea002b2d627371957d7adaff224950903d3ff  -
+-- DISK=694fd850e84cde18ce1187a3da13e68897d5b0f5d049a3f309812c61b0eba330  -
+-- PSQL=694fd850e84cde18ce1187a3da13e68897d5b0f5d049a3f309812c61b0eba330  -
 --
 -- pgdump-lite database dump
 --
@@ -55,7 +55,8 @@ CREATE TYPE enum_alert_source AS ENUM (
 	'grafana',
 	'manual',
 	'prometheusAlertmanager',
-	'site24x7'
+	'site24x7',
+	'universal'
 );
 
 CREATE TYPE enum_alert_status AS ENUM (
@@ -75,7 +76,8 @@ CREATE TYPE enum_integration_keys_type AS ENUM (
 	'generic',
 	'grafana',
 	'prometheusAlertmanager',
-	'site24x7'
+	'site24x7',
+	'universal'
 );
 
 CREATE TYPE enum_limit_type AS ENUM (

diff --git a/web/src/schema.d.ts b/web/src/schema.d.ts
@@ -595,6 +595,7 @@ export type IntegrationKeyType =
   | 'grafana'
   | 'prometheusAlertmanager'
   | 'site24x7'
+  | 'universal'
 
 export interface IntegrationKeyTypeInfo {
   enabled: boolean