*: Prevent anypb.New usage (#10735)

timflannagan · web-flow · commit b18e2e03c262 · 2025-03-04T01:47:22.000Z
Signed-off-by: timflannagan &lt;timflannagan@gmail.com&gt;
diff --git a/.golangci.yaml b/.golangci.yaml
@@ -15,6 +15,7 @@ linters:
     # We are aiming to progressively enable linters.
     # If you see a linter that can be added, please do so.
     - bodyclose
+    - forbidigo
     - ginkgolinter
     - goimports
     - misspell
@@ -59,6 +60,10 @@ linters-settings:
   misspell:
     ignore-words:
     - kgateway
+  forbidigo:
+    forbid:
+      - p: "anypb.New"
+        msg: "Do not use anypb.New; Use utils.MessageToAny instead."
 
 issues:
   # Maximum count of issues with the same text.
diff --git a/internal/kgateway/extensions2/plugins/backend/aws.go b/internal/kgateway/extensions2/plugins/backend/aws.go
@@ -12,11 +12,11 @@ import (
 	envoyauth "github.com/envoyproxy/go-control-plane/envoy/extensions/transport_sockets/tls/v3"
 	"github.com/envoyproxy/go-control-plane/pkg/wellknown"
 	awspb "github.com/solo-io/envoy-gloo/go/config/filter/http/aws_lambda/v2"
-	"google.golang.org/protobuf/types/known/anypb"
 
 	"github.com/kgateway-dev/kgateway/v2/api/v1alpha1"
 	"github.com/kgateway-dev/kgateway/v2/internal/kgateway/extensions2/pluginutils"
 	"github.com/kgateway-dev/kgateway/v2/internal/kgateway/ir"
+	"github.com/kgateway-dev/kgateway/v2/internal/kgateway/utils"
 )
 
 const (
@@ -49,7 +49,7 @@ func processAws(ctx context.Context, in *v1alpha1.AwsBackend, ir *BackendIr, out
 		// TODO(yuval-k): Add verification context
 		Sni: lambdaHostname,
 	}
-	typedConfig, err := anypb.New(tlsContext)
+	typedConfig, err := utils.MessageToAny(tlsContext)
 	if err != nil {
 		// return err
 		return
@@ -122,7 +122,7 @@ func (p *backendPlugin) processBackendAws(
 		//UnwrapAsAlb:       destination.GetUnwrapAsAlb(),
 		//TransformerConfig: transformerConfig,
 	}
-	lambdaRouteFuncAny, err := anypb.New(lambdaRouteFunc)
+	lambdaRouteFuncAny, err := utils.MessageToAny(lambdaRouteFunc)
 	if err != nil {
 		return err
 	}
diff --git a/internal/kgateway/extensions2/plugins/istio/plugin.go b/internal/kgateway/extensions2/plugins/istio/plugin.go
@@ -6,7 +6,6 @@ import (
 	"strconv"
 	"time"
 
-	"google.golang.org/protobuf/types/known/anypb"
 	"google.golang.org/protobuf/types/known/structpb"
 	"istio.io/istio/pkg/kube/krt"
 	"k8s.io/apimachinery/pkg/runtime/schema"
@@ -22,6 +21,7 @@ import (
 	"github.com/kgateway-dev/kgateway/v2/internal/kgateway/extensions2/common"
 	extensionsplug "github.com/kgateway-dev/kgateway/v2/internal/kgateway/extensions2/plugin"
 	"github.com/kgateway-dev/kgateway/v2/internal/kgateway/ir"
+	"github.com/kgateway-dev/kgateway/v2/internal/kgateway/utils"
 	ourwellknown "github.com/kgateway-dev/kgateway/v2/internal/kgateway/wellknown"
 	"github.com/kgateway-dev/kgateway/v2/pkg/utils/envutils"
 )
@@ -203,7 +203,7 @@ func createIstioMatch(sni string) *envoy_config_cluster_v3.Cluster_TransportSock
 		},
 	}
 
-	typedConfig, _ := anypb.New(sslSds)
+	typedConfig, _ := utils.MessageToAny(sslSds)
 	transportSocket := &envoy_config_core_v3.TransportSocket{
 		Name:       wellknown.TransportSocketTls,
 		ConfigType: &envoy_config_core_v3.TransportSocket_TypedConfig{TypedConfig: typedConfig},
@@ -218,7 +218,7 @@ func createIstioMatch(sni string) *envoy_config_cluster_v3.Cluster_TransportSock
 
 func createDefaultIstioMatch() *envoy_config_cluster_v3.Cluster_TransportSocketMatch {
 	// Based on Istio's default match https://github.com/istio/istio/blob/fa321ebd2a1186325788b0f461aa9f36a1a8d90e/pilot/pkg/xds/filters/filters.go#L78
-	typedConfig, _ := anypb.New(&sockets_raw_buffer.RawBuffer{})
+	typedConfig, _ := utils.MessageToAny(&sockets_raw_buffer.RawBuffer{})
 	rawBufferTransportSocket := &envoy_config_core_v3.TransportSocket{
 		Name:       wellknown.TransportSocketRawBuffer,
 		ConfigType: &envoy_config_core_v3.TransportSocket_TypedConfig{TypedConfig: typedConfig},
diff --git a/internal/kgateway/proxy_syncer/xdswrapper.go b/internal/kgateway/proxy_syncer/xdswrapper.go
@@ -8,6 +8,7 @@ import (
 	envoycachetypes "github.com/envoyproxy/go-control-plane/pkg/cache/types"
 	envoycache "github.com/envoyproxy/go-control-plane/pkg/cache/v3"
 
+	"github.com/kgateway-dev/kgateway/v2/internal/kgateway/utils"
 	"github.com/kgateway-dev/kgateway/v2/internal/kgateway/xds"
 	"github.com/kgateway-dev/kgateway/v2/pkg/utils/envutils"
 
@@ -181,7 +182,7 @@ func visitMessage(msg protoreflect.Message, fd protoreflect.FieldDescriptor, v p
 	}
 	visitFields(visitMsg, sensitive)
 	if anyMsg != nil {
-		anymsg, _ := anypb.New(anyMsg)
+		anymsg, _ := utils.MessageToAny(anyMsg)
 		msg.Set(fd, protoreflect.ValueOf(anymsg.ProtoReflect()))
 	}
 }
diff --git a/internal/kgateway/proxy_syncer/xdswrapper_test.go b/internal/kgateway/proxy_syncer/xdswrapper_test.go
@@ -13,10 +13,11 @@ import (
 	"google.golang.org/protobuf/types/known/anypb"
 
 	. "github.com/kgateway-dev/kgateway/v2/internal/kgateway/proxy_syncer"
+	"github.com/kgateway-dev/kgateway/v2/internal/kgateway/utils"
 )
 
 func mustAny(src proto.Message) *anypb.Any {
-	a, e := anypb.New(src)
+	a, e := utils.MessageToAny(src)
 	if e != nil {
 		panic(e)
 	}
diff --git a/internal/kgateway/translator/irtranslator/fc.go b/internal/kgateway/translator/irtranslator/fc.go
@@ -18,7 +18,6 @@ import (
 	envoy_tls_inspector "github.com/envoyproxy/go-control-plane/envoy/extensions/filters/listener/tls_inspector/v3"
 	"github.com/solo-io/go-utils/contextutils"
 	"google.golang.org/protobuf/proto"
-	"google.golang.org/protobuf/types/known/anypb"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	gwv1 "sigs.k8s.io/gateway-api/apis/v1"
 
@@ -72,7 +71,7 @@ func computeListenerAddress(bindAddress string, port uint32, reporter reports.Ga
 
 func tlsInspectorFilter() *envoy_config_listener_v3.ListenerFilter {
 	configEnvoy := &envoy_tls_inspector.TlsInspector{}
-	msg, _ := anypb.New(configEnvoy)
+	msg, _ := utils.MessageToAny(configEnvoy)
 	return &envoy_config_listener_v3.ListenerFilter{
 		Name: wellknown.TlsInspector,
 		ConfigType: &envoy_config_listener_v3.ListenerFilter_TypedConfig{
@@ -401,7 +400,7 @@ func NewFilterWithTypedConfig(name string, config proto.Message) (*envoy_config_
 	}
 
 	if config != nil {
-		marshalledConf, err := anypb.New(config)
+		marshalledConf, err := utils.MessageToAny(config)
 		if err != nil {
 			// this should NEVER HAPPEN!
 			return &envoy_config_listener_v3.Filter{}, err
@@ -482,7 +481,7 @@ func (info *FilterChainInfo) toTransportSocket() *envoy_config_core_v3.Transport
 	out := &envoyauth.DownstreamTlsContext{
 		CommonTlsContext: common,
 	}
-	typedConfig, _ := anypb.New(out)
+	typedConfig, _ := utils.MessageToAny(out)
 
 	return &envoy_config_core_v3.TransportSocket{
 		Name:       wellknown.TransportSocketTls,
diff --git a/internal/kgateway/translator/utils/cluster.go b/internal/kgateway/translator/utils/cluster.go
@@ -4,9 +4,10 @@ import (
 	envoy_config_cluster_v3 "github.com/envoyproxy/go-control-plane/envoy/config/cluster/v3"
 	envoy_config_core_v3 "github.com/envoyproxy/go-control-plane/envoy/config/core/v3"
 	envoy_upstreams_v3 "github.com/envoyproxy/go-control-plane/envoy/extensions/upstreams/http/v3"
+	proto "google.golang.org/protobuf/proto"
 	"google.golang.org/protobuf/types/known/anypb"
 
-	proto "google.golang.org/protobuf/proto"
+	"github.com/kgateway-dev/kgateway/v2/internal/kgateway/utils"
 )
 
 func MutateHttpOptions(c *envoy_config_cluster_v3.Cluster, m func(*envoy_upstreams_v3.HttpProtocolOptions)) error {
@@ -22,7 +23,7 @@ func MutateHttpOptions(c *envoy_config_cluster_v3.Cluster, m func(*envoy_upstrea
 	}
 	m(http2ProtocolOptions)
 
-	a, err := anypb.New(http2ProtocolOptions)
+	a, err := utils.MessageToAny(http2ProtocolOptions)
 	if err != nil {
 		return err
 	}
diff --git a/pkg/utils/envoyutils/bootstrap/bootstrap.go b/pkg/utils/envoyutils/bootstrap/bootstrap.go
@@ -53,7 +53,7 @@ func FromEnvoyResources(resources *EnvoyResources) (string, error) {
 // per-filter config matching the arguments, marshals it to json, and returns
 // the stringified json or any error if it occurred.
 func FromFilter(filterName string, msg proto.Message) (string, error) {
-	typedFilter, err := anypb.New(msg)
+	typedFilter, err := utils.MessageToAny(msg)
 	if err != nil {
 		return "", err
 	}
@@ -83,7 +83,7 @@ func FromFilter(filterName string, msg proto.Message) (string, error) {
 		},
 	}
 
-	hcmAny, err := anypb.New(hcm)
+	hcmAny, err := utils.MessageToAny(hcm)
 	if err != nil {
 		return "", err
 	}
@@ -324,7 +324,7 @@ func setStaticRouteConfig(
 		RouteConfig: r,
 	}
 
-	hcmAny, err := anypb.New(hcm)
+	hcmAny, err := utils.MessageToAny(hcm)
 	if err != nil {
 		return err
 	}

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@ import (`
`8`	`8`	`envoycachetypes "github.com/envoyproxy/go-control-plane/pkg/cache/types"`
`9`	`9`	`envoycache "github.com/envoyproxy/go-control-plane/pkg/cache/v3"`
`10`	`10`
	`11`	`+ "github.com/kgateway-dev/kgateway/v2/internal/kgateway/utils"`
`11`	`12`	`"github.com/kgateway-dev/kgateway/v2/internal/kgateway/xds"`
`12`	`13`	`"github.com/kgateway-dev/kgateway/v2/pkg/utils/envutils"`
`13`	`14`
`@@ -181,7 +182,7 @@ func visitMessage(msg protoreflect.Message, fd protoreflect.FieldDescriptor, v p`
`181`	`182`	`}`
`182`	`183`	`visitFields(visitMsg, sensitive)`
`183`	`184`	`if anyMsg != nil {`
`184`		`- anymsg, _ := anypb.New(anyMsg)`
	`185`	`+ anymsg, _ := utils.MessageToAny(anyMsg)`
`185`	`186`	`msg.Set(fd, protoreflect.ValueOf(anymsg.ProtoReflect()))`
`186`	`187`	`}`
`187`	`188`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,10 +13,11 @@ import (`
`13`	`13`	`"google.golang.org/protobuf/types/known/anypb"`
`14`	`14`
`15`	`15`	`. "github.com/kgateway-dev/kgateway/v2/internal/kgateway/proxy_syncer"`
	`16`	`+ "github.com/kgateway-dev/kgateway/v2/internal/kgateway/utils"`
`16`	`17`	`)`
`17`	`18`
`18`	`19`	`func mustAny(src proto.Message) *anypb.Any {`
`19`		`- a, e := anypb.New(src)`
	`20`	`+ a, e := utils.MessageToAny(src)`
`20`	`21`	`if e != nil {`
`21`	`22`	`panic(e)`
`22`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,9 +4,10 @@ import (`
`4`	`4`	`envoy_config_cluster_v3 "github.com/envoyproxy/go-control-plane/envoy/config/cluster/v3"`
`5`	`5`	`envoy_config_core_v3 "github.com/envoyproxy/go-control-plane/envoy/config/core/v3"`
`6`	`6`	`envoy_upstreams_v3 "github.com/envoyproxy/go-control-plane/envoy/extensions/upstreams/http/v3"`
	`7`	`+ proto "google.golang.org/protobuf/proto"`
`7`	`8`	`"google.golang.org/protobuf/types/known/anypb"`
`8`	`9`
`9`		`- proto "google.golang.org/protobuf/proto"`
	`10`	`+ "github.com/kgateway-dev/kgateway/v2/internal/kgateway/utils"`
`10`	`11`	`)`
`11`	`12`
`12`	`13`	`func MutateHttpOptions(c envoy_config_cluster_v3.Cluster, m func(envoy_upstreams_v3.HttpProtocolOptions)) error {`
`@@ -22,7 +23,7 @@ func MutateHttpOptions(c envoy_config_cluster_v3.Cluster, m func(envoy_upstrea`
`22`	`23`	`}`
`23`	`24`	`m(http2ProtocolOptions)`
`24`	`25`
`25`		`- a, err := anypb.New(http2ProtocolOptions)`
	`26`	`+ a, err := utils.MessageToAny(http2ProtocolOptions)`
`26`	`27`	`if err != nil {`
`27`	`28`	`return err`
`28`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ func FromEnvoyResources(resources *EnvoyResources) (string, error) {`
`53`	`53`	`// per-filter config matching the arguments, marshals it to json, and returns`
`54`	`54`	`// the stringified json or any error if it occurred.`
`55`	`55`	`func FromFilter(filterName string, msg proto.Message) (string, error) {`
`56`		`- typedFilter, err := anypb.New(msg)`
	`56`	`+ typedFilter, err := utils.MessageToAny(msg)`
`57`	`57`	`if err != nil {`
`58`	`58`	`return "", err`
`59`	`59`	`}`
`@@ -83,7 +83,7 @@ func FromFilter(filterName string, msg proto.Message) (string, error) {`
`83`	`83`	`},`
`84`	`84`	`}`
`85`	`85`
`86`		`- hcmAny, err := anypb.New(hcm)`
	`86`	`+ hcmAny, err := utils.MessageToAny(hcm)`
`87`	`87`	`if err != nil {`
`88`	`88`	`return "", err`
`89`	`89`	`}`
`@@ -324,7 +324,7 @@ func setStaticRouteConfig(`
`324`	`324`	`RouteConfig: r,`
`325`	`325`	`}`
`326`	`326`
`327`		`- hcmAny, err := anypb.New(hcm)`
	`327`	`+ hcmAny, err := utils.MessageToAny(hcm)`
`328`	`328`	`if err != nil {`
`329`	`329`	`return err`
`330`	`330`	`}`