treat filter config as opaque JSON value

Kong · Mar 25, 2024 · 70da1db · 70da1db
1 parent 9bc2d81
commit 70da1db
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 20 deletions.
diff --git a/kong/filter_chain.go b/kong/filter_chain.go
@@ -1,5 +1,7 @@
 package kong
 
+import "encoding/json"
+
 // FilterChain represents a FilterChain in Kong.
 // Read https://docs.konghq.com/gateway/latest/admin-api/#filter-chain-object
 // +k8s:deepcopy-gen=true
@@ -18,9 +20,9 @@ type FilterChain struct {
 // Filter contains information about each filter in the chain
 // +k8s:deepcopy-gen=true
 type Filter struct {
-	Name    *string `json:"name,omitempty" yaml:"name,omitempty"`
-	Config  *string `json:"config,omitempty" yaml:"config,omitempty"`
-	Enabled *bool   `json:"enabled,omitempty" yaml:"enabled,omitempty"`
+	Name    *string          `json:"name,omitempty" yaml:"name,omitempty"`
+	Config  *json.RawMessage `json:"config,omitempty" yaml:"config,omitempty"`
+	Enabled *bool            `json:"enabled,omitempty" yaml:"enabled,omitempty"`
 }
 
 // FriendlyName returns the endpoint key name or ID.

diff --git a/kong/filter_chain_service_test.go b/kong/filter_chain_service_test.go
@@ -36,7 +36,7 @@ func TestFilterChainsService(T *testing.T) {
 		Filters: []*Filter{
 			{
 				Name:   String("example-filter"),
-				Config: String("{ \"my_greeting\": \"Howdy\" }"),
+				Config: JsonRawMessage(`"{ \"my_greeting\": \"Howdy\" }"`),
 			},
 		},
 		Service: service,
@@ -67,7 +67,7 @@ func TestFilterChainsService(T *testing.T) {
 		Filters: []*Filter{
 			{
 				Name:   String("example-filter"),
-				Config: String("{ \"my_greeting\": \"Howdy\" }"),
+				Config: JsonRawMessage(`"{ \"my_greeting\": \"Howdy\" }"`),
 			},
 		},
 		Service: service,
@@ -100,7 +100,7 @@ func TestFilterChainsService(T *testing.T) {
 		Filters: []*Filter{
 			{
 				Name:    String("example-filter"),
-				Config:  String("{ \"my_greeting\": \"Howdy\" }"),
+				Config:  JsonRawMessage(`"{ \"my_greeting\": \"Howdy\" }"`),
 				Enabled: Bool(true),
 			},
 		},
@@ -128,7 +128,7 @@ func TestFilterChainsService(T *testing.T) {
 		Filters: []*Filter{
 			{
 				Name:    String("example-filter"),
-				Config:  String("{ \"my_greeting\": \"Howdy\" }"),
+				Config:  JsonRawMessage(`"{ \"my_greeting\": \"Howdy\" }"`),
 				Enabled: Bool(true),
 			},
 		},
@@ -155,7 +155,7 @@ func TestFilterChainsService(T *testing.T) {
 		Filters: []*Filter{
 			{
 				Name:    String("example-filter"),
-				Config:  String("{ \"my_greeting\": \"Howdy\" }"),
+				Config:  JsonRawMessage(`"{ \"my_greeting\": \"Howdy\" }"`),
 				Enabled: Bool(true),
 			},
 		},
@@ -183,7 +183,7 @@ func TestFilterChainsService(T *testing.T) {
 		Filters: []*Filter{
 			{
 				Name:    String("example-filter"),
-				Config:  String("{ \"my_greeting\": \"Howdy\" }"),
+				Config:  JsonRawMessage(`"{ \"my_greeting\": \"Howdy\" }"`),
 				Enabled: Bool(true),
 			},
 		},
@@ -222,7 +222,7 @@ func TestFilterChainWithTags(T *testing.T) {
 		Filters: []*Filter{
 			{
 				Name:   String("example-filter"),
-				Config: String("{ \"my_greeting\": \"Howdy\" }"),
+				Config: JsonRawMessage(`"{ \"my_greeting\": \"Howdy\" }"`),
 			},
 		},
 		Service: createdService,
@@ -267,7 +267,7 @@ func TestUnknownFilterChain(T *testing.T) {
 		Filters: []*Filter{
 			{
 				Name:   String("filter-chain-not-present"),
-				Config: String("{ \"option\": true }"),
+				Config: JsonRawMessage(`"{ \"option\": true }"`),
 			},
 		},
 		Service: createdService,
@@ -299,7 +299,7 @@ func TestFilterChainListEndpoint(T *testing.T) {
 			Filters: []*Filter{
 				{
 					Name:   String("example-filter"),
-					Config: String("{ \"my_greeting\": \"Hi\" }"),
+					Config: JsonRawMessage(`"{ \"my_greeting\": \"Hi\" }"`),
 				},
 			},
 		},
@@ -308,7 +308,7 @@ func TestFilterChainListEndpoint(T *testing.T) {
 			Filters: []*Filter{
 				{
 					Name:   String("example-filter"),
-					Config: String("{ \"my_greeting\": \"Hey\" }"),
+					Config: JsonRawMessage(`"{ \"my_greeting\": \"Hey\" }"`),
 				},
 			},
 		},
@@ -317,7 +317,7 @@ func TestFilterChainListEndpoint(T *testing.T) {
 			Filters: []*Filter{
 				{
 					Name:   String("example-filter"),
-					Config: String("{ \"my_greeting\": \"Howdy\" }"),
+					Config: JsonRawMessage(`"{ \"my_greeting\": \"Howdy\" }"`),
 				},
 			},
 		},
@@ -424,11 +424,11 @@ func TestFilterChainListAllForEntityEndpoint(T *testing.T) {
 			Filters: []*Filter{
 				{
 					Name:   String("example-filter"),
-					Config: String("{ \"my_greeting\": \"Hello, route\" }"),
+					Config: JsonRawMessage(`"{ \"my_greeting\": \"Hello, route\" }"`),
 				},
 				{
 					Name:   String("example-filter"),
-					Config: String("{ \"option\": false }"),
+					Config: JsonRawMessage(`"{ \"option\": false }"`),
 				},
 			},
 			Route: createdRoute,
@@ -439,11 +439,11 @@ func TestFilterChainListAllForEntityEndpoint(T *testing.T) {
 			Filters: []*Filter{
 				{
 					Name:   String("example-filter"),
-					Config: String("{ \"option\": false }"),
+					Config: JsonRawMessage(`"{ \"option\": false }"`),
 				},
 				{
 					Name:   String("example-filter"),
-					Config: String("{ \"my_greeting\": \"Hello, service\" }"),
+					Config: JsonRawMessage(`"{ \"my_greeting\": \"Hello, service\" }"`),
 				},
 			},
 			Service: createdService,

diff --git a/kong/utils.go b/kong/utils.go
@@ -42,6 +42,12 @@ func Float64(f float64) *float64 {
 	return &f
 }
 
+// JsonRawMessage returns a pointer to a json.RawMessage
+func JsonRawMessage(s string) *json.RawMessage {
+	j := json.RawMessage(s)
+	return &j
+}
+
 func isEmptyString(s *string) bool {
 	return s == nil || strings.TrimSpace(*s) == ""
 }

diff --git a/kong/zz_generated.deepcopy.go b/kong/zz_generated.deepcopy.go