int keys: Add support for externally-managed integration keys (#3818)

* add optional external_system_name * add api support for external name * add mapping for constraint * fix migrate down * list externally managed keys separately * add extra delete confirmation for ext keys * update schema * sort by system name first
target · Apr 23, 2024 · 0fe4b6d · 0fe4b6d
1 parent 80b49c9
commit 0fe4b6d
Show file tree

Hide file tree

Showing 15 changed files with 275 additions and 41 deletions.
diff --git a/gadb/models.go b/gadb/models.go
diff --git a/gadb/queries.sql.go b/gadb/queries.sql.go
diff --git a/graphql2/generated.go b/graphql2/generated.go
diff --git a/graphql2/graphqlapp/integrationkey.go b/graphql2/graphqlapp/integrationkey.go
@@ -29,6 +29,9 @@ func (m *Mutation) CreateIntegrationKey(ctx context.Context, input graphql2.Crea
 			Name:      input.Name,
 			Type:      integrationkey.Type(input.Type),
 		}
+		if input.ExternalSystemName != nil {
+			key.ExternalSystemName = *input.ExternalSystemName
+		}
 		key, err = m.IntKeyStore.Create(ctx, tx, key)
 		return err
 	})

diff --git a/graphql2/models_gen.go b/graphql2/models_gen.go
diff --git a/graphql2/schema.graphql b/graphql2/schema.graphql
@@ -990,6 +990,11 @@ input CreateIntegrationKeyInput {
   serviceID: ID
   type: IntegrationKeyType!
   name: String!
+
+  """
+  Name of the external system this key is managed by.
+  """
+  externalSystemName: String
 }
 
 input CreateHeartbeatMonitorInput {
@@ -1034,6 +1039,11 @@ type IntegrationKey {
   type: IntegrationKeyType!
   name: String!
   href: String!
+
+  """
+  Name of the external system this key is managed by.
+  """
+  externalSystemName: String
 }
 
 enum IntegrationKeyType {

diff --git a/integrationkey/integrationkey.go b/integrationkey/integrationkey.go
@@ -9,13 +9,16 @@ type IntegrationKey struct {
 	Name      string `json:"name"`
 	Type      Type   `json:"type"`
 	ServiceID string `json:"service_id"`
+
+	ExternalSystemName string
 }
 
 func (i IntegrationKey) Normalize() (*IntegrationKey, error) {
 	err := validate.Many(
 		validate.IDName("Name", i.Name),
 		validate.UUID("ServiceID", i.ServiceID),
 		validate.OneOf("Type", i.Type, TypeGrafana, TypeSite24x7, TypePrometheusAlertmanager, TypeGeneric, TypeEmail),
+		validate.ASCII("ExternalSystemName", i.ExternalSystemName, 0, 255),
 	)
 	if err != nil {
 		return nil, err

diff --git a/integrationkey/queries.sql b/integrationkey/queries.sql
@@ -8,15 +8,16 @@ WHERE
     AND type = $2;
 
 -- name: IntKeyCreate :exec
-INSERT INTO integration_keys(id, name, type, service_id)
-    VALUES ($1, $2, $3, $4);
+INSERT INTO integration_keys(id, name, type, service_id, external_system_name)
+    VALUES ($1, $2, $3, $4, $5);
 
 -- name: IntKeyFindOne :one
 SELECT
     id,
     name,
     type,
-    service_id
+    service_id,
+    external_system_name
 FROM
     integration_keys
 WHERE
@@ -27,7 +28,8 @@ SELECT
     id,
     name,
     type,
-    service_id
+    service_id,
+    external_system_name
 FROM
     integration_keys
 WHERE

diff --git a/integrationkey/store.go b/integrationkey/store.go
@@ -92,6 +92,8 @@ func (s *Store) Create(ctx context.Context, dbtx gadb.DBTX, i *IntegrationKey) (
 		Name:      n.Name,
 		Type:      gadb.EnumIntegrationKeysType(n.Type),
 		ServiceID: serviceUUID,
+
+		ExternalSystemName: sql.NullString{String: n.ExternalSystemName, Valid: n.ExternalSystemName != ""},
 	})
 	if err != nil {
 		return nil, err
@@ -142,6 +144,8 @@ func (s *Store) FindOne(ctx context.Context, id string) (*IntegrationKey, error)
 		Name:      row.Name,
 		Type:      Type(row.Type),
 		ServiceID: row.ServiceID.String(),
+
+		ExternalSystemName: row.ExternalSystemName.String,
 	}, nil
 }
 
@@ -167,6 +171,8 @@ func (s *Store) FindAllByService(ctx context.Context, serviceID string) ([]Integ
 			Name:      row.Name,
 			Type:      Type(row.Type),
 			ServiceID: row.ServiceID.String(),
+
+			ExternalSystemName: row.ExternalSystemName.String,
 		}
 	}
 	return keys, nil