refactor: move common code into cmdhelpers/ (#5121)

thomaspoignant · web-flow · commit 6b2e88d4e73c · 2026-04-12T10:11:03.000+02:00
* chore: Move common code into cmdhelper/

Signed-off-by: Thomas Poignant &lt;thomas.poignant@gofeatureflag.org&gt;

* chore: simplify nil check in ZapLogger call

* fix: use the correct middleware

Signed-off-by: Thomas Poignant &lt;thomas.poignant@gofeatureflag.org&gt;

---------

Signed-off-by: Thomas Poignant &lt;thomas.poignant@gofeatureflag.org&gt;
diff --git a/cmd/cli/evaluate/evaluate_cmd_test.go b/cmd/cli/evaluate/evaluate_cmd_test.go
@@ -7,9 +7,10 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	"github.com/thomaspoignant/go-feature-flag/cmd/cli/evaluate"
-	"github.com/thomaspoignant/go-feature-flag/cmd/relayproxy/helper"
 )
 
+const XAPIKeyHeader = "X-API-Key"
+
 func TestCmdEvaluate(t *testing.T) {
 	tests := []struct {
 		name           string
@@ -123,9 +124,9 @@ func TestCmdEvaluate(t *testing.T) {
 				"--header",
 				"Content-Type: application/json",
 				"--header",
-				helper.XAPIKeyHeader + ": 123456",
+				XAPIKeyHeader + ": 123456",
 				"--header",
-				helper.XAPIKeyHeader + ": 654321",
+				XAPIKeyHeader + ": 654321",
 				"--flag",
 				"test-flag",
 				"--ctx",
diff --git a/cmd/editor/main.go b/cmd/editor/main.go
@@ -7,8 +7,8 @@ import (
 	echoadapter "github.com/awslabs/aws-lambda-go-api-proxy/echo"
 	"github.com/labstack/echo/v4"
 	"github.com/labstack/echo/v4/middleware"
-	custommiddleware "github.com/thomaspoignant/go-feature-flag/cmd/relayproxy/api/middleware"
-	"github.com/thomaspoignant/go-feature-flag/cmd/relayproxy/log"
+	custommiddleware "github.com/thomaspoignant/go-feature-flag/cmdhelpers/api/middleware"
+	"github.com/thomaspoignant/go-feature-flag/cmdhelpers/log"
 	"github.com/thomaspoignant/go-feature-flag/modules/core/dto"
 	"github.com/thomaspoignant/go-feature-flag/modules/core/flag"
 	"github.com/thomaspoignant/go-feature-flag/modules/core/model"
@@ -24,7 +24,7 @@ func main() {
 	defer func() { _ = logger.ZapLogger.Sync() }()
 
 	e := echo.New()
-	e.Use(custommiddleware.ZapLogger(logger.ZapLogger, nil))
+	e.Use(custommiddleware.ZapLogger(logger.ZapLogger, false))
 	e.Use(middleware.CORSWithConfig(middleware.CORSConfig{
 		AllowOrigins: []string{
 			"http://gofeatureflag.org",
diff --git a/cmd/relayproxy/api/opentelemetry/otel_test.go b/cmd/relayproxy/api/opentelemetry/otel_test.go
@@ -12,7 +12,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	"github.com/thomaspoignant/go-feature-flag/cmd/relayproxy/config"
-	"github.com/thomaspoignant/go-feature-flag/cmd/relayproxy/log"
+	"github.com/thomaspoignant/go-feature-flag/cmdhelpers/log"
 	"go.opentelemetry.io/otel"
 	"go.opentelemetry.io/otel/attribute"
 	sdktrace "go.opentelemetry.io/otel/sdk/trace"
diff --git a/cmd/relayproxy/api/routes_monitoring.go b/cmd/relayproxy/api/routes_monitoring.go
@@ -8,6 +8,7 @@ import (
 	custommiddleware "github.com/thomaspoignant/go-feature-flag/cmd/relayproxy/api/middleware"
 	"github.com/thomaspoignant/go-feature-flag/cmd/relayproxy/controller"
 	"github.com/thomaspoignant/go-feature-flag/cmd/relayproxy/metric"
+	helpermiddleware "github.com/thomaspoignant/go-feature-flag/cmdhelpers/api/middleware"
 )
 
 func (s *Server) addMonitoringRoutes() {
@@ -16,7 +17,7 @@ func (s *Server) addMonitoringRoutes() {
 		s.monitoringEcho.HideBanner = true
 		s.monitoringEcho.HidePort = true
 		s.monitoringEcho.Debug = s.config.IsDebugEnabled()
-		s.monitoringEcho.Use(custommiddleware.ZapLogger(s.zapLog, s.config))
+		s.monitoringEcho.Use(helpermiddleware.ZapLogger(s.zapLog, s.config.IsDebugEnabled()))
 		s.monitoringEcho.Use(middleware.CORSWithConfig(middleware.DefaultCORSConfig))
 		s.apiEcho.Use(custommiddleware.VersionHeader(custommiddleware.VersionHeaderConfig{
 			RelayProxyConfig: s.config,
diff --git a/cmd/relayproxy/api/server.go b/cmd/relayproxy/api/server.go
@@ -21,6 +21,7 @@ import (
 	"github.com/thomaspoignant/go-feature-flag/cmd/relayproxy/metric"
 	"github.com/thomaspoignant/go-feature-flag/cmd/relayproxy/ofrep"
 	"github.com/thomaspoignant/go-feature-flag/cmd/relayproxy/service"
+	helpermiddleware "github.com/thomaspoignant/go-feature-flag/cmdhelpers/api/middleware"
 	"go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho"
 	"go.uber.org/zap"
 )
@@ -57,7 +58,7 @@ func (s *Server) initRoutes() {
 	s.apiEcho.HidePort = true
 	s.apiEcho.Debug = s.config.IsDebugEnabled()
 	s.apiEcho.Use(otelecho.Middleware("go-feature-flag"))
-	s.apiEcho.Use(custommiddleware.ZapLogger(s.zapLog, s.config))
+	s.apiEcho.Use(helpermiddleware.ZapLogger(s.zapLog, s.config.IsDebugEnabled()))
 	s.apiEcho.Use(middleware.BodyDumpWithConfig(middleware.BodyDumpConfig{
 		Skipper: func(c echo.Context) bool {
 			isSwagger := strings.HasPrefix(c.Request().URL.String(), "/swagger")
diff --git a/cmd/relayproxy/api/server_test.go b/cmd/relayproxy/api/server_test.go
@@ -19,9 +19,9 @@ import (
 	"github.com/stretchr/testify/require"
 	"github.com/thomaspoignant/go-feature-flag/cmd/relayproxy/api"
 	"github.com/thomaspoignant/go-feature-flag/cmd/relayproxy/config"
-	"github.com/thomaspoignant/go-feature-flag/cmd/relayproxy/log"
 	"github.com/thomaspoignant/go-feature-flag/cmd/relayproxy/metric"
 	"github.com/thomaspoignant/go-feature-flag/cmd/relayproxy/service"
+	"github.com/thomaspoignant/go-feature-flag/cmdhelpers/log"
 	"github.com/thomaspoignant/go-feature-flag/cmdhelpers/retrieverconf"
 	"github.com/thomaspoignant/go-feature-flag/notifier"
 	"go.uber.org/zap"
diff --git a/cmd/relayproxy/main.go b/cmd/relayproxy/main.go
@@ -11,9 +11,9 @@ import (
 	"github.com/thomaspoignant/go-feature-flag/cmd/relayproxy/api"
 	"github.com/thomaspoignant/go-feature-flag/cmd/relayproxy/config"
 	"github.com/thomaspoignant/go-feature-flag/cmd/relayproxy/docs"
-	"github.com/thomaspoignant/go-feature-flag/cmd/relayproxy/log"
 	"github.com/thomaspoignant/go-feature-flag/cmd/relayproxy/metric"
 	"github.com/thomaspoignant/go-feature-flag/cmd/relayproxy/service"
+	"github.com/thomaspoignant/go-feature-flag/cmdhelpers/log"
 	"github.com/thomaspoignant/go-feature-flag/notifier"
 	"go.uber.org/zap"
 )
diff --git a/cmd/wasm/go.mod b/cmd/wasm/go.mod
@@ -19,7 +19,7 @@ require (
 	github.com/diegoholiveira/jsonlogic/v3 v3.9.0 // indirect
 	github.com/nikunjy/rules v1.5.0 // indirect
 	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
-	golang.org/x/exp v0.0.0-20240506185415-9bf2ced13842 // indirect
+	golang.org/x/exp v0.0.0-20240719175910-8a7402abbf56 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )
 
diff --git a/cmd/wasm/go.sum b/cmd/wasm/go.sum
@@ -25,8 +25,8 @@ github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu
 github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
 github.com/thomaspoignant/go-feature-flag/modules/core v0.6.1 h1:9+SSjY/i4EXgNlGHqiNYXjPYB4q7SwWROvCtVwPvv2w=
 github.com/thomaspoignant/go-feature-flag/modules/core v0.6.1/go.mod h1:9Ps6MAWMG/SfwOufGVoX88y+SMk+b1Uhwn5txYusVF0=
-golang.org/x/exp v0.0.0-20240506185415-9bf2ced13842 h1:vr/HnozRka3pE4EsMEg1lgkXJkTFJCVUX+S/ZT6wYzM=
-golang.org/x/exp v0.0.0-20240506185415-9bf2ced13842/go.mod h1:XtvwrStGgqGPLc4cjQfWqZHG1YFdYs6swckp8vpsjnc=
+golang.org/x/exp v0.0.0-20240719175910-8a7402abbf56 h1:2dVuKD2vS7b0QIHQbpyTISPd0LeHDbnYEryqj5Q1ug8=
+golang.org/x/exp v0.0.0-20240719175910-8a7402abbf56/go.mod h1:M4RDyNAINzryxdtnbRXRL/OHtkFuWGRjvuhBJpk2IlY=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
 gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=
diff --git a/cmdhelpers/api/middleware/zap.go b/cmdhelpers/api/middleware/zap.go
@@ -7,7 +7,6 @@ import (
 
 	"github.com/labstack/echo/v4"
 	"github.com/labstack/echo/v4/middleware"
-	"github.com/thomaspoignant/go-feature-flag/cmd/relayproxy/config"
 	"go.uber.org/zap"
 	"go.uber.org/zap/zapcore"
 )
@@ -31,10 +30,10 @@ func DebugSkipper(_ echo.Context) bool {
 }
 
 // ZapLogger is a middleware and zap to provide an "access log" like logging for each request.
-func ZapLogger(log *zap.Logger, cfg *config.Config) echo.MiddlewareFunc {
+func ZapLogger(log *zap.Logger, isDebugEnabled bool) echo.MiddlewareFunc {
 	// select the right skipper
 	skipper := DefaultSkipper
-	if cfg != nil && cfg.IsDebugEnabled() {
+	if isDebugEnabled {
 		skipper = DebugSkipper
 	}
 
diff --git a/cmdhelpers/api/middleware/zap_test.go b/cmdhelpers/api/middleware/zap_test.go
@@ -7,8 +7,7 @@ import (
 
 	"github.com/labstack/echo/v4"
 	"github.com/stretchr/testify/assert"
-	"github.com/thomaspoignant/go-feature-flag/cmd/relayproxy/api/middleware"
-	"github.com/thomaspoignant/go-feature-flag/cmd/relayproxy/config"
+	"github.com/thomaspoignant/go-feature-flag/cmdhelpers/api/middleware"
 	"go.uber.org/zap"
 	"go.uber.org/zap/zaptest/observer"
 )
@@ -25,7 +24,7 @@ func TestZapLogger200(t *testing.T) {
 
 	obs, logs := observer.New(zap.DebugLevel)
 	logger := zap.New(obs)
-	err := middleware.ZapLogger(logger, &config.Config{})(h)(c)
+	err := middleware.ZapLogger(logger, false)(h)(c)
 	assert.Nil(t, err)
 	logFields := logs.AllUntimed()[0].ContextMap()
 	assert.Equal(t, 1, logs.Len())
@@ -48,7 +47,7 @@ func TestZapLogger300(t *testing.T) {
 
 	obs, logs := observer.New(zap.DebugLevel)
 	logger := zap.New(obs)
-	err := middleware.ZapLogger(logger, &config.Config{})(h)(c)
+	err := middleware.ZapLogger(logger, false)(h)(c)
 	assert.Nil(t, err)
 	logFields := logs.AllUntimed()[0].ContextMap()
 	assert.Equal(t, 1, logs.Len())
@@ -70,7 +69,7 @@ func TestZapLogger400(t *testing.T) {
 
 	obs, logs := observer.New(zap.DebugLevel)
 	logger := zap.New(obs)
-	err := middleware.ZapLogger(logger, &config.Config{})(h)(c)
+	err := middleware.ZapLogger(logger, false)(h)(c)
 	assert.Nil(t, err)
 	logFields := logs.AllUntimed()[0].ContextMap()
 	assert.Equal(t, 1, logs.Len())
@@ -93,7 +92,7 @@ func TestZapLogger500(t *testing.T) {
 
 	obs, logs := observer.New(zap.ErrorLevel)
 	logger := zap.New(obs)
-	err := middleware.ZapLogger(logger, &config.Config{})(h)(c)
+	err := middleware.ZapLogger(logger, false)(h)(c)
 	assert.Nil(t, err)
 	logFields := logs.AllUntimed()[0].ContextMap()
 	assert.Equal(t, 1, logs.Len())
@@ -116,7 +115,7 @@ func TestZapLoggerHealth(t *testing.T) {
 
 	obs, logs := observer.New(zap.DebugLevel)
 	logger := zap.New(obs)
-	err := middleware.ZapLogger(logger, &config.Config{})(h)(c)
+	err := middleware.ZapLogger(logger, false)(h)(c)
 	assert.Nil(t, err)
 	assert.Equal(t, 0, len(logs.AllUntimed()))
 }
@@ -133,7 +132,7 @@ func TestZapLoggerHealthDebug(t *testing.T) {
 
 	obs, logs := observer.New(zap.DebugLevel)
 	logger := zap.New(obs)
-	err := middleware.ZapLogger(logger, &config.Config{LogLevel: "debug"})(h)(c)
+	err := middleware.ZapLogger(logger, true)(h)(c)
 	assert.Nil(t, err)
 	assert.Equal(t, 1, len(logs.AllUntimed()))
 }
diff --git a/cmdhelpers/log/logger.go b/cmdhelpers/log/logger.go
diff --git a/cmdhelpers/log/logger_test.go b/cmdhelpers/log/logger_test.go
@@ -7,7 +7,7 @@ import (
 
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
-	"github.com/thomaspoignant/go-feature-flag/cmd/relayproxy/log"
+	"github.com/thomaspoignant/go-feature-flag/cmdhelpers/log"
 	"go.uber.org/zap"
 )
 
diff --git a/go.mod b/go.mod
@@ -24,7 +24,7 @@ require (
 	github.com/awslabs/aws-lambda-go-api-proxy v0.16.2
 	github.com/fsouza/fake-gcs-server v1.54.0
 	github.com/go-viper/mapstructure/v2 v2.5.0
-	github.com/golang/mock v1.6.0
+	github.com/golang/mock v1.7.0-rc.1
 	github.com/google/go-cmp v0.7.0
 	github.com/google/uuid v1.6.0
 	github.com/gorilla/websocket v1.5.4-0.20250319132907-e064f32e3674
@@ -40,7 +40,7 @@ require (
 	github.com/knadh/koanf/providers/file v1.2.1
 	github.com/knadh/koanf/providers/posflag v1.0.1
 	github.com/knadh/koanf/v2 v2.3.4
-	github.com/labstack/echo-contrib v0.17.4
+	github.com/labstack/echo-contrib v0.50.1
 	github.com/labstack/echo/v4 v4.15.1
 	github.com/luci/go-render v0.0.0-20160219211803-9a04cc21af0f
 	github.com/pablor21/echo-etag/v4 v4.0.5
@@ -54,7 +54,7 @@ require (
 	github.com/spf13/cobra v1.10.2
 	github.com/spf13/pflag v1.0.10
 	github.com/stretchr/testify v1.11.1
-	github.com/swaggo/echo-swagger v1.4.1
+	github.com/swaggo/echo-swagger v1.5.2
 	github.com/swaggo/swag v1.16.6
 	github.com/testcontainers/testcontainers-go v0.42.0
 	github.com/testcontainers/testcontainers-go/modules/azure v0.42.0
@@ -152,20 +152,20 @@ require (
 	github.com/felixge/httpsnoop v1.0.4 // indirect
 	github.com/fsnotify/fsnotify v1.9.0 // indirect
 	github.com/fxamacker/cbor/v2 v2.9.0 // indirect
-	github.com/ghodss/yaml v1.0.0 // indirect
 	github.com/go-jose/go-jose/v4 v4.1.4 // indirect
 	github.com/go-logr/logr v1.4.3 // indirect
 	github.com/go-logr/stdr v1.2.2 // indirect
 	github.com/go-ole/go-ole v1.2.6 // indirect
 	github.com/go-openapi/jsonpointer v0.21.0 // indirect
 	github.com/go-openapi/jsonreference v0.21.0 // indirect
-	github.com/go-openapi/spec v0.21.0 // indirect
+	github.com/go-openapi/spec v0.20.9 // indirect
 	github.com/go-openapi/swag v0.23.0 // indirect
 	github.com/goccy/go-reflect v1.2.0 // indirect
 	github.com/gogo/googleapis v1.4.1 // indirect
 	github.com/gogo/protobuf v1.3.2 // indirect
 	github.com/golang-jwt/jwt/v5 v5.3.0 // indirect
 	github.com/golang/snappy v1.0.0 // indirect
+	github.com/google/flatbuffers v23.5.26+incompatible // indirect
 	github.com/google/gnostic-models v0.7.0 // indirect
 	github.com/google/renameio/v2 v2.0.0 // indirect
 	github.com/google/s2a-go v0.1.9 // indirect
@@ -221,6 +221,7 @@ require (
 	github.com/pelletier/go-toml v1.9.5 // indirect
 	github.com/pierrec/lz4/v4 v4.1.25 // indirect
 	github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c // indirect
+	github.com/pkg/errors v0.9.1 // indirect
 	github.com/pkg/xattr v0.4.12 // indirect
 	github.com/planetscale/vtprotobuf v0.6.1-0.20240319094008-0393e58bdf10 // indirect
 	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
@@ -233,7 +234,9 @@ require (
 	github.com/shirou/gopsutil/v4 v4.26.3 // indirect
 	github.com/sirupsen/logrus v1.9.4 // indirect
 	github.com/spiffe/go-spiffe/v2 v2.6.0 // indirect
+	github.com/sv-tools/openapi v0.2.1 // indirect
 	github.com/swaggo/files/v2 v2.0.0 // indirect
+	github.com/swaggo/swag/v2 v2.0.0-rc4 // indirect
 	github.com/tklauser/go-sysconf v0.3.16 // indirect
 	github.com/tklauser/numcpus v0.11.0 // indirect
 	github.com/valyala/bytebufferpool v1.0.0 // indirect
@@ -275,7 +278,7 @@ require (
 	go.yaml.in/yaml/v2 v2.4.4 // indirect
 	go.yaml.in/yaml/v3 v3.0.4 // indirect
 	golang.org/x/crypto v0.50.0 // indirect
-	golang.org/x/exp v0.0.0-20240506185415-9bf2ced13842 // indirect
+	golang.org/x/exp v0.0.0-20240719175910-8a7402abbf56 // indirect
 	golang.org/x/mod v0.34.0 // indirect
 	golang.org/x/oauth2 v0.36.0 // indirect
 	golang.org/x/sync v0.20.0 // indirect
@@ -284,7 +287,7 @@ require (
 	golang.org/x/text v0.36.0 // indirect
 	golang.org/x/time v0.15.0 // indirect
 	golang.org/x/tools v0.43.0 // indirect
-	golang.org/x/xerrors v0.0.0-20231012003039-104605ab7028 // indirect
+	golang.org/x/xerrors v0.0.0-20240903120638-7835f813f4da // indirect
 	google.golang.org/genproto v0.0.0-20260319201613-d00831a3d3e7 // indirect
 	google.golang.org/genproto/googleapis/api v0.0.0-20260406210006-6f92a3bedf2d // indirect
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20260406210006-6f92a3bedf2d // indirect
diff --git a/go.sum b/go.sum
diff --git a/modules/core/go.mod b/modules/core/go.mod
diff --git a/modules/core/go.sum b/modules/core/go.sum

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ require (`
`19`	`19`	`github.com/diegoholiveira/jsonlogic/v3 v3.9.0 // indirect`
`20`	`20`	`github.com/nikunjy/rules v1.5.0 // indirect`
`21`	`21`	`github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect`
`22`		`- golang.org/x/exp v0.0.0-20240506185415-9bf2ced13842 // indirect`
	`22`	`+ golang.org/x/exp v0.0.0-20240719175910-8a7402abbf56 // indirect`
`23`	`23`	`gopkg.in/yaml.v3 v3.0.1 // indirect`
`24`	`24`	`)`
`25`	`25`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,6 @@ import (`
`7`	`7`
`8`	`8`	`"github.com/labstack/echo/v4"`
`9`	`9`	`"github.com/labstack/echo/v4/middleware"`
`10`		`- "github.com/thomaspoignant/go-feature-flag/cmd/relayproxy/config"`
`11`	`10`	`"go.uber.org/zap"`
`12`	`11`	`"go.uber.org/zap/zapcore"`
`13`	`12`	`)`
`@@ -31,10 +30,10 @@ func DebugSkipper(_ echo.Context) bool {`
`31`	`30`	`}`
`32`	`31`
`33`	`32`	`// ZapLogger is a middleware and zap to provide an "access log" like logging for each request.`
`34`		`-func ZapLogger(log zap.Logger, cfg config.Config) echo.MiddlewareFunc {`
	`33`	`+func ZapLogger(log *zap.Logger, isDebugEnabled bool) echo.MiddlewareFunc {`
`35`	`34`	`// select the right skipper`
`36`	`35`	`skipper := DefaultSkipper`
`37`		`- if cfg != nil && cfg.IsDebugEnabled() {`
	`36`	`+ if isDebugEnabled {`
`38`	`37`	`skipper = DebugSkipper`
`39`	`38`	`}`
`40`	`39`