feat(OFREP): return unsupported types field (#1846)

thomaspoignant · Aug 16, 2024 · 86bc58f · 86bc58f
1 parent 241564c
commit 86bc58f
Show file tree

Hide file tree

Showing 6 changed files with 44 additions and 2 deletions.
diff --git a/cmd/relayproxy/docs/docs.go b/cmd/relayproxy/docs/docs.go
@@ -735,6 +735,9 @@ const docTemplate = `{
             "properties": {
                 "cacheInvalidation": {
                     "$ref": "#/definitions/model.OFREPConfigCapabilitiesCacheInvalidation"
+                },
+                "flagEvaluation": {
+                    "$ref": "#/definitions/model.OFREPConfigCapabilitiesFlagEvaluation"
                 }
             }
         },
@@ -757,6 +760,17 @@ const docTemplate = `{
                 }
             }
         },
+        "model.OFREPConfigCapabilitiesFlagEvaluation": {
+            "type": "object",
+            "properties": {
+                "unsupportedTypes": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            }
+        },
         "model.OFREPConfiguration": {
             "type": "object",
             "properties": {

diff --git a/cmd/relayproxy/docs/swagger.json b/cmd/relayproxy/docs/swagger.json
@@ -727,6 +727,9 @@
             "properties": {
                 "cacheInvalidation": {
                     "$ref": "#/definitions/model.OFREPConfigCapabilitiesCacheInvalidation"
+                },
+                "flagEvaluation": {
+                    "$ref": "#/definitions/model.OFREPConfigCapabilitiesFlagEvaluation"
                 }
             }
         },
@@ -749,6 +752,17 @@
                 }
             }
         },
+        "model.OFREPConfigCapabilitiesFlagEvaluation": {
+            "type": "object",
+            "properties": {
+                "unsupportedTypes": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            }
+        },
         "model.OFREPConfiguration": {
             "type": "object",
             "properties": {

diff --git a/cmd/relayproxy/docs/swagger.yaml b/cmd/relayproxy/docs/swagger.yaml
@@ -190,6 +190,8 @@ definitions:
     properties:
       cacheInvalidation:
         $ref: '#/definitions/model.OFREPConfigCapabilitiesCacheInvalidation'
+      flagEvaluation:
+        $ref: '#/definitions/model.OFREPConfigCapabilitiesFlagEvaluation'
     type: object
   model.OFREPConfigCapabilitiesCacheInvalidation:
     properties:
@@ -203,6 +205,13 @@ definitions:
       minPollingInterval:
         type: integer
     type: object
+  model.OFREPConfigCapabilitiesFlagEvaluation:
+    properties:
+      unsupportedTypes:
+        items:
+          type: string
+        type: array
+    type: object
   model.OFREPConfiguration:
     properties:
       capabilities:

diff --git a/cmd/relayproxy/model/ofrep_configuration.go b/cmd/relayproxy/model/ofrep_configuration.go
@@ -7,11 +7,15 @@ type OFREPConfiguration struct {
 
 type OFREPConfigCapabilities struct {
 	CacheInvalidation OFREPConfigCapabilitiesCacheInvalidation `json:"cacheInvalidation,omitempty"`
+	FlagEvaluation    OFREPConfigCapabilitiesFlagEvaluation    `json:"flagEvaluation,omitempty"`
 }
 
 type OFREPConfigCapabilitiesCacheInvalidation struct {
 	Polling OFREPConfigCapabilitiesCacheInvalidationPolling `json:"polling,omitempty"`
 }
+type OFREPConfigCapabilitiesFlagEvaluation struct {
+	UnsupportedTypes []string `json:"unsupportedTypes"`
+}
 
 type OFREPConfigCapabilitiesCacheInvalidationPolling struct {
 	Enabled            bool  `json:"enabled,omitempty"`

diff --git a/cmd/relayproxy/ofrep/configuration.go b/cmd/relayproxy/ofrep/configuration.go
@@ -34,6 +34,7 @@ func (h *EvaluateCtrl) Configuration(c echo.Context) error {
 					MinPollingInterval: h.goFF.GetPollingInterval(),
 				},
 			},
+			FlagEvaluation: model.OFREPConfigCapabilitiesFlagEvaluation{UnsupportedTypes: []string{}},
 		},
 	}
 	return c.JSON(http.StatusOK, response)

diff --git a/cmd/relayproxy/ofrep/configuration_test.go b/cmd/relayproxy/ofrep/configuration_test.go
@@ -31,15 +31,15 @@ func Test_Configuration(t *testing.T) {
 			goffPolling: 10 * time.Second,
 			want: want{
 				httpCode: http.StatusOK,
-				response: "{\"name\":\"GO Feature Flag\",\"capabilities\":{\"cacheInvalidation\":{\"polling\":{\"enabled\":true,\"minPollingInterval\":10000}}}}",
+				response: "{\"name\":\"GO Feature Flag\",\"capabilities\":{\"cacheInvalidation\":{\"polling\":{\"enabled\":true,\"minPollingInterval\":10000}},\"flagEvaluation\":{\"unsupportedTypes\":[]}}}",
 			},
 		},
 		{
 			name:        "configuration 10 minute",
 			goffPolling: 10 * time.Minute,
 			want: want{
 				httpCode: http.StatusOK,
-				response: "{\"name\":\"GO Feature Flag\",\"capabilities\":{\"cacheInvalidation\":{\"polling\":{\"enabled\":true,\"minPollingInterval\":600000}}}}",
+				response: "{\"name\":\"GO Feature Flag\",\"capabilities\":{\"cacheInvalidation\":{\"polling\":{\"enabled\":true,\"minPollingInterval\":600000}},\"flagEvaluation\":{\"unsupportedTypes\":[]}}}",
 			},
 		},
 	}