Adding test + fixing OFREP issue (#1760)

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>
thomaspoignant · Apr 15, 2024 · add7232 · add7232
1 parent 2a35d96
commit add7232
Show file tree

Hide file tree

Showing 28 changed files with 512 additions and 29 deletions.
diff --git a/cmd/relayproxy/controller/all_flags.go b/cmd/relayproxy/controller/all_flags.go
@@ -26,6 +26,7 @@ func NewAllFlags(goFF *ffclient.GoFeatureFlag, metrics metric.Metrics) Controlle
 
 // Handler is the entry point for the allFlags endpoint
 // @Summary      All flags variations for a user
+// @Tags GO Feature Flag Evaluation API
 // @Description  Making a **POST** request to the URL `/v1/allflags` will give you the values of all the flags for
 // @Description this user.
 // @Description

diff --git a/cmd/relayproxy/controller/collect_eval_data.go b/cmd/relayproxy/controller/collect_eval_data.go
@@ -28,6 +28,7 @@ func NewCollectEvalData(goFF *ffclient.GoFeatureFlag, metrics metric.Metrics) Co
 
 // Handler is the entry point for the data/collector endpoint
 // @Summary      Endpoint to send usage of your flags to be collected
+// @Tags GO Feature Flag Evaluation API
 // @Description  This endpoint is receiving the events of your flags usage to send them in the data collector.
 // @Description
 // @Description  It is used by the different Open Feature providers to send in bulk all the cached events to avoid

diff --git a/cmd/relayproxy/controller/flag_eval.go b/cmd/relayproxy/controller/flag_eval.go
@@ -27,6 +27,7 @@ func NewFlagEval(goFF *ffclient.GoFeatureFlag, metrics metric.Metrics) Controlle
 
 // Handler is the entry point for the flag eval endpoint
 // @Summary     Evaluate a feature flag
+// @Tags GO Feature Flag Evaluation API
 // @Description Making a **POST** request to the URL `/v1/feature/<your_flag_name>/eval` will give you the value of the
 // @Description flag for this user.
 // @Description

diff --git a/cmd/relayproxy/controller/health.go b/cmd/relayproxy/controller/health.go
@@ -20,6 +20,7 @@ func NewHealth(monitoring service.Monitoring) Controller {
 
 // Handler is the entry point for this API
 // @Summary      Health
+// @Tags Monitoring
 // @Description Making a **GET** request to the URL path `/health` will tell you if the relay proxy is ready to serve
 // @Description traffic.
 // @Description

diff --git a/cmd/relayproxy/controller/info.go b/cmd/relayproxy/controller/info.go
@@ -19,6 +19,7 @@ func NewInfo(monitoring service.Monitoring) Controller {
 
 // Handler is the entry point for the Info API
 // @Summary      Info
+// @Tags Monitoring
 // @Description  Making a **GET** request to the URL path `/info` will give you information about the actual state
 // @Description  of the relay proxy.
 // @Description

diff --git a/cmd/relayproxy/controller/ws_flag_change.go b/cmd/relayproxy/controller/ws_flag_change.go
@@ -32,6 +32,7 @@ type wsFlagChange struct {
 
 // Handler is the entry point for the websocket endpoint to get notified when a flag has been edited
 // @Summary      Websocket endpoint to be notified about flag changes
+// @Tags GO Feature Flag Evaluation API
 // @Description  This endpoint is a websocket endpoint to be notified about flag changes, every change
 // @Description  will send a request to the client with a model.DiffCache format.
 // @Description

diff --git a/cmd/relayproxy/docs/docs.go b/cmd/relayproxy/docs/docs.go
@@ -32,6 +32,9 @@ const docTemplate = `{
                 "produces": [
                     "application/json"
                 ],
+                "tags": [
+                    "Monitoring"
+                ],
                 "summary": "Health",
                 "responses": {
                     "200": {
@@ -49,6 +52,9 @@ const docTemplate = `{
                 "produces": [
                     "application/json"
                 ],
+                "tags": [
+                    "Monitoring"
+                ],
                 "summary": "Info",
                 "responses": {
                     "200": {
@@ -66,6 +72,9 @@ const docTemplate = `{
                 "produces": [
                     "text/plain"
                 ],
+                "tags": [
+                    "Monitoring"
+                ],
                 "summary": "Prometheus endpoint",
                 "responses": {
                     "200": {
@@ -91,6 +100,9 @@ const docTemplate = `{
                 "produces": [
                     "application/json"
                 ],
+                "tags": [
+                    "OpenFeature Remote Evaluation Protocol (OFREP)"
+                ],
                 "summary": "Open-Feature Remote Evaluation Protocol bulk evaluation API.",
                 "parameters": [
                     {
@@ -157,6 +169,9 @@ const docTemplate = `{
                 "produces": [
                     "application/json"
                 ],
+                "tags": [
+                    "OpenFeature Remote Evaluation Protocol (OFREP)"
+                ],
                 "summary": "Evaluate a feature flag using the OpenFeature Remote Evaluation Protocol",
                 "parameters": [
                     {
@@ -224,6 +239,9 @@ const docTemplate = `{
                 "produces": [
                     "application/json"
                 ],
+                "tags": [
+                    "GO Feature Flag Evaluation API"
+                ],
                 "summary": "All flags variations for a user",
                 "parameters": [
                     {
@@ -272,6 +290,9 @@ const docTemplate = `{
                 "produces": [
                     "application/json"
                 ],
+                "tags": [
+                    "GO Feature Flag Evaluation API"
+                ],
                 "summary": "Endpoint to send usage of your flags to be collected",
                 "parameters": [
                     {
@@ -320,6 +341,9 @@ const docTemplate = `{
                 "produces": [
                     "application/json"
                 ],
+                "tags": [
+                    "GO Feature Flag Evaluation API"
+                ],
                 "summary": "Evaluate a feature flag",
                 "parameters": [
                     {
@@ -370,6 +394,9 @@ const docTemplate = `{
                 "produces": [
                     "application/json"
                 ],
+                "tags": [
+                    "GO Feature Flag Evaluation API"
+                ],
                 "summary": "Websocket endpoint to be notified about flag changes",
                 "parameters": [
                     {

diff --git a/cmd/relayproxy/docs/swagger.json b/cmd/relayproxy/docs/swagger.json
@@ -24,6 +24,9 @@
                 "produces": [
                     "application/json"
                 ],
+                "tags": [
+                    "Monitoring"
+                ],
                 "summary": "Health",
                 "responses": {
                     "200": {
@@ -41,6 +44,9 @@
                 "produces": [
                     "application/json"
                 ],
+                "tags": [
+                    "Monitoring"
+                ],
                 "summary": "Info",
                 "responses": {
                     "200": {
@@ -58,6 +64,9 @@
                 "produces": [
                     "text/plain"
                 ],
+                "tags": [
+                    "Monitoring"
+                ],
                 "summary": "Prometheus endpoint",
                 "responses": {
                     "200": {
@@ -83,6 +92,9 @@
                 "produces": [
                     "application/json"
                 ],
+                "tags": [
+                    "OpenFeature Remote Evaluation Protocol (OFREP)"
+                ],
                 "summary": "Open-Feature Remote Evaluation Protocol bulk evaluation API.",
                 "parameters": [
                     {
@@ -149,6 +161,9 @@
                 "produces": [
                     "application/json"
                 ],
+                "tags": [
+                    "OpenFeature Remote Evaluation Protocol (OFREP)"
+                ],
                 "summary": "Evaluate a feature flag using the OpenFeature Remote Evaluation Protocol",
                 "parameters": [
                     {
@@ -216,6 +231,9 @@
                 "produces": [
                     "application/json"
                 ],
+                "tags": [
+                    "GO Feature Flag Evaluation API"
+                ],
                 "summary": "All flags variations for a user",
                 "parameters": [
                     {
@@ -264,6 +282,9 @@
                 "produces": [
                     "application/json"
                 ],
+                "tags": [
+                    "GO Feature Flag Evaluation API"
+                ],
                 "summary": "Endpoint to send usage of your flags to be collected",
                 "parameters": [
                     {
@@ -312,6 +333,9 @@
                 "produces": [
                     "application/json"
                 ],
+                "tags": [
+                    "GO Feature Flag Evaluation API"
+                ],
                 "summary": "Evaluate a feature flag",
                 "parameters": [
                     {
@@ -362,6 +386,9 @@
                 "produces": [
                     "application/json"
                 ],
+                "tags": [
+                    "GO Feature Flag Evaluation API"
+                ],
                 "summary": "Websocket endpoint to be notified about flag changes",
                 "parameters": [
                     {

diff --git a/cmd/relayproxy/docs/swagger.yaml b/cmd/relayproxy/docs/swagger.yaml
@@ -386,6 +386,8 @@ paths:
           schema:
             $ref: '#/definitions/model.HealthResponse'
       summary: Health
+      tags:
+      - Monitoring
   /info:
     get:
       description: |-
@@ -402,6 +404,8 @@ paths:
           schema:
             $ref: '#/definitions/model.InfoResponse'
       summary: Info
+      tags:
+      - Monitoring
   /metrics:
     get:
       description: This endpoint is providing metrics about the relay proxy in the
@@ -414,6 +418,8 @@ paths:
           schema:
             type: string
       summary: Prometheus endpoint
+      tags:
+      - Monitoring
   /ofrep/v1/evaluate/flags:
     post:
       consumes:
@@ -460,6 +466,8 @@ paths:
       security:
       - ApiKeyAuth: []
       summary: Open-Feature Remote Evaluation Protocol bulk evaluation API.
+      tags:
+      - OpenFeature Remote Evaluation Protocol (OFREP)
   /ofrep/v1/evaluate/flags/{flag_key}:
     post:
       consumes:
@@ -505,6 +513,8 @@ paths:
       security:
       - ApiKeyAuth: []
       summary: Evaluate a feature flag using the OpenFeature Remote Evaluation Protocol
+      tags:
+      - OpenFeature Remote Evaluation Protocol (OFREP)
   /v1/allflags:
     post:
       consumes:
@@ -540,6 +550,8 @@ paths:
       security:
       - ApiKeyAuth: []
       summary: All flags variations for a user
+      tags:
+      - GO Feature Flag Evaluation API
   /v1/data/collector:
     post:
       consumes:
@@ -574,6 +586,8 @@ paths:
       security:
       - ApiKeyAuth: []
       summary: Endpoint to send usage of your flags to be collected
+      tags:
+      - GO Feature Flag Evaluation API
   /v1/feature/{flag_key}/eval:
     post:
       consumes:
@@ -619,6 +633,8 @@ paths:
       security:
       - ApiKeyAuth: []
       summary: Evaluate a feature flag
+      tags:
+      - GO Feature Flag Evaluation API
   /ws/v1/flag/change:
     post:
       consumes:
@@ -647,6 +663,8 @@ paths:
           schema:
             $ref: '#/definitions/modeldocs.HTTPErrorDoc'
       summary: Websocket endpoint to be notified about flag changes
+      tags:
+      - GO Feature Flag Evaluation API
 securityDefinitions:
   ApiKeyAuth:
     description: Use configured APIKeys in yaml config as authorization keys, disabled

diff --git a/cmd/relayproxy/model/ofrep_error_response.go b/cmd/relayproxy/model/ofrep_error_response.go
@@ -1,6 +1,9 @@
 package model
 
-import "github.com/thomaspoignant/go-feature-flag/internal/flag"
+import (
+	"fmt"
+	"github.com/thomaspoignant/go-feature-flag/internal/flag"
+)
 
 type OFREPEvaluateErrorResponse struct {
 	OFREPCommonErrorResponse `json:",inline" yaml:",inline" toml:",inline"`
@@ -11,3 +14,7 @@ type OFREPCommonErrorResponse struct {
 	ErrorCode    flag.ErrorCode `json:"errorCode"`
 	ErrorDetails string         `json:"errorDetails"`
 }
+
+func (o *OFREPCommonErrorResponse) Error() string {
+	return fmt.Sprintf("[%s] %s", o.ErrorCode, o.ErrorDetails)
+}
diff --git a/cmd/relayproxy/model/ofrep_success_response.go b/cmd/relayproxy/model/ofrep_success_response.go
@@ -5,5 +5,5 @@ type OFREPEvaluateSuccessResponse struct {
 	Value    any            `json:"value"`
 	Reason   string         `json:"reason"`
 	Variant  string         `json:"variant"`
-	Metadata map[string]any `json:"metadata"`
+	Metadata map[string]any `json:"metadata,omitempty"`
 }
diff --git a/cmd/relayproxy/modeldocs/metricsController.go b/cmd/relayproxy/modeldocs/metricsController.go
@@ -5,6 +5,7 @@ import "github.com/labstack/echo/v4"
 // FakeMetricsController is the entry point for the allFlags endpoint
 //
 // @Summary      Prometheus endpoint
+// @Tags Monitoring
 // @Description  This endpoint is providing metrics about the relay proxy in the prometheus format.
 // @Produce      plain
 // @Success      200 {object}	string