feat: added support for degraphql_routes (#154)

* feat: added support for degraphql_routes * chore: fixed lint issues * chore: fixed code comments * chore: addressed PR comments * fix: renamed plugin_entities to custom_entities for clarity * fix: fixed comment strings * fix: fixed schema
Kong · Jan 23, 2025 · 2772231 · 2772231
1 parent 353fe98
commit 2772231
Show file tree

Hide file tree

Showing 17 changed files with 1,025 additions and 4 deletions.
diff --git a/pkg/diff/diff.go b/pkg/diff/diff.go
@@ -265,6 +265,8 @@ func (sc *Syncer) init() error {
 		types.ServicePackage, types.ServiceVersion, types.Document,
 
 		types.FilterChain,
+
+		types.DegraphqlRoute,
 	}
 
 	sc.entityDiffers = map[types.EntityType]types.Differ{}

diff --git a/pkg/diff/order.go b/pkg/diff/order.go
@@ -24,6 +24,7 @@ L3      +---------------------------> Service <---+  +-> Route               |
         |                                 |          |     v                 |
 L4      +----------> Document   <---------+          +-> Plugins / <---------+
                                                          FilterChains
+														 CustomEntities - DegraphqlRoute
 */
 
 // dependencyOrder defines the order in which entities will be synced by decK.
@@ -64,6 +65,7 @@ var dependencyOrder = [][]types.EntityType{
 		types.Plugin,
 		types.FilterChain,
 		types.Document,
+		types.DegraphqlRoute,
 	},
 }
 

diff --git a/pkg/file/builder.go b/pkg/file/builder.go
@@ -115,6 +115,7 @@ func (b *stateBuilder) build() (*utils.KongRawState, *utils.KonnectRawState, err
 	b.consumers()
 	b.plugins()
 	b.filterChains()
+	b.customEntities()
 	b.enterprise()
 
 	// konnect
@@ -1568,6 +1569,108 @@ func filterChainRelations(filterChain *kong.FilterChain) (rID, sID string) {
 	return
 }
 
+func (b *stateBuilder) customEntities() {
+	if b.err != nil {
+		return
+	}
+
+	supportedCustomEntities := map[string]bool{
+		degraphqlRoutesType: true,
+	}
+
+	var customEntities []FCustomEntity
+	for _, e := range b.targetContent.CustomEntities {
+		if !supportedCustomEntities[*e.Type] {
+			b.err = fmt.Errorf("custom entity %v is not supported", *e.Type)
+			return
+		}
+
+		customEntities = append(customEntities, e)
+	}
+
+	b.ingestCustomEntities(customEntities)
+}
+
+func (b *stateBuilder) ingestCustomEntities(customEntities []FCustomEntity) {
+	for _, e := range customEntities {
+		switch *e.Type {
+		case degraphqlRoutesType:
+			b.ingestDeGraphqlRoute(e)
+		}
+	}
+}
+
+func (b *stateBuilder) ingestDeGraphqlRoute(degraphqlRouteEntity FCustomEntity) {
+	degraphqlRoute, err := copyToDegraphqlRoute(degraphqlRouteEntity)
+	if err != nil {
+		b.err = err
+		return
+	}
+
+	if utils.Empty(degraphqlRoute.ID) {
+		d, err := b.currentState.DegraphqlRoutes.GetByURIQuery(*degraphqlRoute.URI, *degraphqlRoute.Query)
+		if errors.Is(err, state.ErrNotFound) {
+			degraphqlRoute.ID = uuid()
+		} else if err != nil {
+			b.err = err
+			return
+		} else {
+			degraphqlRoute.ID = kong.String(*d.ID)
+		}
+	} else {
+		degraphqlRoute.ID = kong.String(*degraphqlRoute.ID)
+	}
+
+	b.rawState.DegraphqlRoutes = append(b.rawState.DegraphqlRoutes, &degraphqlRoute.DegraphqlRoute)
+}
+
+func copyToDegraphqlRoute(fcEntity FCustomEntity) (DegraphqlRoute, error) {
+	degraphqlRoute := DegraphqlRoute{}
+	if fcEntity.ID != nil {
+		degraphqlRoute.ID = fcEntity.ID
+	}
+
+	if fcEntity.Fields == nil {
+		return DegraphqlRoute{}, fmt.Errorf("fields are required for degraphql_routes")
+	}
+
+	if fcEntity.Fields["service"] != nil {
+		if service, ok := fcEntity.Fields["service"].(*string); ok {
+			degraphqlRoute.Service = &kong.Service{
+				ID: service,
+			}
+		}
+	}
+
+	if fcEntity.Fields["uri"] != nil {
+		if uri, ok := fcEntity.Fields["uri"].(*string); ok {
+			degraphqlRoute.URI = uri
+		}
+	}
+
+	if fcEntity.Fields["query"] != nil {
+		if query, ok := fcEntity.Fields["query"].(*string); ok {
+			degraphqlRoute.Query = query
+		}
+	}
+
+	if fcEntity.Fields["methods"] != nil {
+		if methods, ok := fcEntity.Fields["methods"].([]*string); ok {
+			methodsString := make([]string, len(methods))
+			for i, method := range methods {
+				methodsString[i] = *method
+			}
+			degraphqlRoute.Methods = kong.StringSlice(methodsString...)
+		}
+	}
+
+	if degraphqlRoute.Methods == nil {
+		degraphqlRoute.Methods = kong.StringSlice("GET")
+	}
+
+	return degraphqlRoute, nil
+}
+
 func defaulter(
 	ctx context.Context, client *kong.Client, fileContent *Content, disableDynamicDefaults, isKonnect bool,
 ) (*utils.Defaulter, error) {

diff --git a/pkg/file/codegen/main.go b/pkg/file/codegen/main.go
@@ -129,6 +129,9 @@ func main() {
 	}
 	schema.Definitions["MTLSAuth"].Required = []string{"id", "subject_name"}
 
+	// custom entities
+	schema.Definitions["FCustomEntity"].Required = []string{"type"}
+
 	// RBAC resources
 	schema.Definitions["FRBACRole"].Required = []string{"name"}
 	schema.Definitions["FRBACEndpointPermission"].Required = []string{"workspace", "endpoint"}

diff --git a/pkg/file/kong_json_schema.json b/pkg/file/kong_json_schema.json
@@ -68,6 +68,13 @@
       },
       "type": "array"
     },
+    "custom_entities": {
+      "items": {
+        "$schema": "http://json-schema.org/draft-04/schema#",
+        "$ref": "#/definitions/FCustomEntity"
+      },
+      "type": "array"
+    },
     "plugins": {
       "items": {
         "$ref": "#/definitions/FPlugin"
@@ -745,6 +752,29 @@
       "additionalProperties": false,
       "type": "object"
     },
+    "FCustomEntity": {
+      "required": [
+        "type"
+      ],
+      "properties": {
+        "fields": {
+          "patternProperties": {
+            ".*": {
+              "additionalProperties": true
+            }
+          },
+          "type": "object"
+        },
+        "id": {
+          "type": "string"
+        },
+        "type": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false,
+      "type": "object"
+    },
     "FRBACEndpointPermission": {
       "required": [
         "workspace",
@@ -1472,25 +1502,25 @@
     },
     "LookUpSelectorTags": {
       "properties": {
-        "consumers": {
+        "consumer_groups": {
           "items": {
             "type": "string"
           },
           "type": "array"
         },
-        "routes": {
+        "consumers": {
           "items": {
             "type": "string"
           },
           "type": "array"
         },
-        "services": {
+        "routes": {
           "items": {
             "type": "string"
           },
           "type": "array"
         },
-        "consumer_groups": {
+        "services": {
           "items": {
             "type": "string"
           },