Backport of parse config protocol on write to optimize disco-chain compilation into release/1.16.x (#19858)

* parse config protocol on write to optimize disco-chain compilation (#19829)

* parse config protocol on write to optimize disco-chain compilation

* add changelog

* add test fixes from PR

* add missing config field

---------

Co-authored-by: Dhia Ayachi <dhia@hashicorp.com>

.changelog/19829.txt

@@ -0,0 +1,3 @@
+```release-note:enhancement
+mesh: parse the proxy-defaults protocol when write the config-entry to avoid parsing it when compiling the discovery chain.
+```

agent/consul/discoverychain/compile.go

@@ -8,14 +8,12 @@ import (
 	"strings"
 	"time"
 
-	"github.com/mitchellh/hashstructure"
-	"github.com/mitchellh/mapstructure"
-
 	"github.com/hashicorp/consul/acl"
 	"github.com/hashicorp/consul/agent/configentry"
 	"github.com/hashicorp/consul/agent/connect"
 	"github.com/hashicorp/consul/agent/structs"
 	"github.com/hashicorp/consul/proto/private/pbpeering"
+	"github.com/mitchellh/hashstructure"
 )
 
 type CompileRequest struct {
@@ -244,21 +242,13 @@ func (c *compiler) recordServiceProtocol(sid structs.ServiceID) error {
 		return c.recordProtocol(sid, serviceDefault.Protocol)
 	}
 	if proxyDefault := c.entries.GetProxyDefaults(sid.PartitionOrDefault()); proxyDefault != nil {
-		var cfg proxyConfig
+		if proxyDefault.Protocol != "" {
-		// Ignore errors and fallback on defaults if it does happen.
+			return c.recordProtocol(sid, proxyDefault.Protocol)
-		_ = mapstructure.WeakDecode(proxyDefault.Config, &cfg)
-		if cfg.Protocol != "" {
-			return c.recordProtocol(sid, cfg.Protocol)
 		}
 	}
 	return c.recordProtocol(sid, "")
 }
 
-// proxyConfig is a snippet from agent/xds/config.go:ProxyConfig
-type proxyConfig struct {
-	Protocol string `mapstructure:"protocol"`
-}
-
 func (c *compiler) recordProtocol(fromService structs.ServiceID, protocol string) error {
 	if protocol == "" {
 		protocol = "tcp"

agent/consul/discoverychain/compile_test.go

@@ -1142,8 +1142,9 @@ func testcase_PeerRedirect() compileTestCase {
 func testcase_PeerRedirectProxyDefHTTP() compileTestCase {
 	entries := newEntries()
 	entries.AddProxyDefaults(&structs.ProxyConfigEntry{
-		Kind: structs.ProxyDefaults,
+		Kind:     structs.ProxyDefaults,
-		Name: structs.ProxyConfigGlobal,
+		Name:     structs.ProxyConfigGlobal,
+		Protocol: "http",
 		Config: map[string]interface{}{
 			"Protocol": "http",
 		},
@@ -1768,8 +1769,9 @@ func testcase_DefaultResolver_WithProxyDefaults() compileTestCase {
 	entries := newEntries()
 
 	entries.AddProxyDefaults(&structs.ProxyConfigEntry{
-		Kind: structs.ProxyDefaults,
+		Kind:     structs.ProxyDefaults,
-		Name: structs.ProxyConfigGlobal,
+		Name:     structs.ProxyConfigGlobal,
+		Protocol: "grpc",
 		Config: map[string]interface{}{
 			"protocol": "grpc",
 		},
@@ -3263,8 +3265,9 @@ func newSimpleRoute(name string, muts ...func(*structs.ServiceRoute)) structs.Se
 
 func setGlobalProxyProtocol(entries *configentry.DiscoveryChainSet, protocol string) {
 	entries.AddProxyDefaults(&structs.ProxyConfigEntry{
-		Kind: structs.ProxyDefaults,
+		Kind:     structs.ProxyDefaults,
-		Name: structs.ProxyConfigGlobal,
+		Name:     structs.ProxyConfigGlobal,
+		Protocol: protocol,
 		Config: map[string]interface{}{
 			"protocol": protocol,
 		},

agent/consul/discoverychain/gateway_test.go

@@ -781,8 +781,9 @@ func TestGatewayChainSynthesizer_ComplexChain(t *testing.T) {
 					}},
 				},
 				&structs.ProxyConfigEntry{
-					Kind: structs.ProxyConfigGlobal,
+					Kind:     structs.ProxyConfigGlobal,
-					Name: "global",
+					Name:     "global",
+					Protocol: "http",
 					Config: map[string]interface{}{
 						"protocol": "http",
 					},

agent/consul/state/config_entry.go

@@ -6,6 +6,7 @@ package state
 import (
 	"errors"
 	"fmt"
+	"github.com/mitchellh/mapstructure"
 	"strings"
 
 	memdb "github.com/hashicorp/go-memdb"
@@ -519,6 +520,11 @@ func insertConfigEntryWithTxn(tx WriteTxn, idx uint64, conf structs.ConfigEntry)
 		if err != nil {
 			return err
 		}
+	case structs.ProxyDefaults:
+		err := addProtocol(conf.(*structs.ProxyConfigEntry))
+		if err != nil {
+			return err
+		}
 	}
 
 	// Assign virtual-ips, if needed
@@ -544,6 +550,21 @@ func insertConfigEntryWithTxn(tx WriteTxn, idx uint64, conf structs.ConfigEntry)
 	return nil
 }
 
+// proxyConfig is a snippet from agent/xds/config.go:ProxyConfig
+type proxyConfig struct {
+	Protocol string `mapstructure:"protocol"`
+}
+
+func addProtocol(conf *structs.ProxyConfigEntry) error {
+	var cfg proxyConfig
+	err := mapstructure.WeakDecode(conf.Config, &cfg)
+	if err != nil {
+		return err
+	}
+	conf.Protocol = cfg.Protocol
+	return nil
+}
+
 func configEntryHasVirtualIP(c structs.ConfigEntry) bool {
 	if c == nil || c.GetName() == "" {
 		return false

agent/consul/state/config_entry_test.go

@@ -24,16 +24,27 @@ import (
 func TestStore_ConfigEntry(t *testing.T) {
 	s := testConfigStateStore(t)
 
+	cfg := &structs.ProxyConfigEntry{
+		Kind: structs.ProxyDefaults,
+		Name: "global",
+		Config: map[string]interface{}{
+			"DestinationServiceName": "foo",
+			"protocol":               "udp",
+		},
+	}
+
 	expected := &structs.ProxyConfigEntry{
 		Kind: structs.ProxyDefaults,
 		Name: "global",
 		Config: map[string]interface{}{
 			"DestinationServiceName": "foo",
+			"protocol":               "udp",
 		},
+		Protocol: "udp",
 	}
 
 	// Create
-	require.NoError(t, s.EnsureConfigEntry(0, expected))
+	require.NoError(t, s.EnsureConfigEntry(0, cfg))
 
 	idx, config, err := s.ConfigEntry(nil, structs.ProxyDefaults, "global", nil)
 	require.NoError(t, err)

agent/proxycfg/manager_test.go

@@ -72,8 +72,9 @@ func TestManager_BasicLifecycle(t *testing.T) {
 	dbSplitChain := func() *structs.CompiledDiscoveryChain {
 		set := configentry.NewDiscoveryChainSet()
 		set.AddEntries(&structs.ProxyConfigEntry{
-			Kind: structs.ProxyDefaults,
+			Kind:     structs.ProxyDefaults,
-			Name: structs.ProxyConfigGlobal,
+			Name:     structs.ProxyConfigGlobal,
+			Protocol: "http",
 			Config: map[string]interface{}{
 				"protocol": "http",
 			},

agent/proxycfg/testing_mesh_gateway.go

@@ -586,6 +586,7 @@ func TestConfigSnapshotPeeredMeshGateway(t testing.T, variant string, nsFn func(
 		)
 	case "default-services-http":
 		proxyDefaults := &structs.ProxyConfigEntry{
+			Protocol: "http",
 			Config: map[string]interface{}{
 				"protocol": "http",
 			},
@@ -687,8 +688,9 @@ func TestConfigSnapshotPeeredMeshGateway(t testing.T, variant string, nsFn func(
 	case "chain-and-l7-stuff":
 		entries = []structs.ConfigEntry{
 			&structs.ProxyConfigEntry{
-				Kind: structs.ProxyDefaults,
+				Kind:     structs.ProxyDefaults,
-				Name: structs.ProxyConfigGlobal,
+				Name:     structs.ProxyConfigGlobal,
+				Protocol: "http",
 				Config: map[string]interface{}{
 					"protocol": "http",
 				},

agent/proxycfg/testing_tproxy.go

@@ -131,8 +131,9 @@ func TestConfigSnapshotTransparentProxy(t testing.T) *ConfigSnapshot {
 func TestConfigSnapshotTransparentProxyHTTPUpstream(t testing.T, additionalEntries ...structs.ConfigEntry) *ConfigSnapshot {
 	// Set default service protocol to HTTP
 	entries := append(additionalEntries, &structs.ProxyConfigEntry{
-		Kind: structs.ProxyDefaults,
+		Kind:     structs.ProxyDefaults,
-		Name: structs.ProxyConfigGlobal,
+		Name:     structs.ProxyConfigGlobal,
+		Protocol: "http",
 		Config: map[string]interface{}{
 			"protocol": "http",
 		},

agent/proxycfg/testing_upstreams.go

@@ -478,6 +478,7 @@ func setupTestVariationDiscoveryChain(
 				Kind:           structs.ProxyDefaults,
 				Name:           structs.ProxyConfigGlobal,
 				EnterpriseMeta: em,
+				Protocol:       "http",
 				Config: map[string]interface{}{
 					"protocol": "http",
 				},
@@ -538,6 +539,7 @@ func setupTestVariationDiscoveryChain(
 				Kind:           structs.ProxyDefaults,
 				Name:           structs.ProxyConfigGlobal,
 				EnterpriseMeta: entMeta,
+				Protocol:       "http",
 				Config: map[string]interface{}{
 					"protocol": "http",
 				},
@@ -593,6 +595,7 @@ func setupTestVariationDiscoveryChain(
 				Kind:           structs.ProxyDefaults,
 				Name:           structs.ProxyConfigGlobal,
 				EnterpriseMeta: entMeta,
+				Protocol:       "grpc",
 				Config: map[string]interface{}{
 					"protocol": "grpc",
 				},
@@ -628,6 +631,7 @@ func setupTestVariationDiscoveryChain(
 				Kind:           structs.ProxyDefaults,
 				Name:           structs.ProxyConfigGlobal,
 				EnterpriseMeta: entMeta,
+				Protocol:       "http",
 				Config: map[string]interface{}{
 					"protocol": "http",
 				},
@@ -879,6 +883,7 @@ func setupTestVariationDiscoveryChain(
 				Kind:           structs.ProxyDefaults,
 				Name:           structs.ProxyConfigGlobal,
 				EnterpriseMeta: entMeta,
+				Protocol:       "http",
 				Config: map[string]interface{}{
 					"protocol": "http",
 				},

agent/structs/config_entry.go

@@ -397,6 +397,7 @@ type ProxyConfigEntry struct {
 	Kind                 string
 	Name                 string
 	Config               map[string]interface{}
+	Protocol             string                               `json:"-"`
 	Mode                 ProxyMode                            `json:",omitempty"`
 	TransparentProxy     TransparentProxyConfig               `json:",omitempty" alias:"transparent_proxy"`
 	MutualTLSMode        MutualTLSMode                        `json:",omitempty" alias:"mutual_tls_mode"`

agent/structs/discovery_chain.go

@@ -116,7 +116,7 @@ func (s *DiscoveryGraphNode) IsResolver() bool {
 }
 
 func (s *DiscoveryGraphNode) MapKey() string {
-	return fmt.Sprintf("%s:%s", s.Type, s.Name)
+	return s.Type + ":" + s.Name
 }
 
 // compiled form of ServiceResolverConfigEntry

agent/xds/listeners_test.go

@@ -76,8 +76,9 @@ func makeListenerDiscoChainTests(enterprise bool) []listenerTestCase {
 			create: func(t testinf.T) *proxycfg.ConfigSnapshot {
 				return proxycfg.TestConfigSnapshotDiscoveryChain(t, "simple", enterprise, nil, nil,
 					&structs.ProxyConfigEntry{
-						Kind: structs.ProxyDefaults,
+						Kind:     structs.ProxyDefaults,
-						Name: structs.ProxyConfigGlobal,
+						Name:     structs.ProxyConfigGlobal,
+						Protocol: "http",
 						Config: map[string]interface{}{
 							"protocol": "http",
 						},
@@ -90,8 +91,9 @@ func makeListenerDiscoChainTests(enterprise bool) []listenerTestCase {
 			create: func(t testinf.T) *proxycfg.ConfigSnapshot {
 				return proxycfg.TestConfigSnapshotDiscoveryChain(t, "simple", enterprise, nil, nil,
 					&structs.ProxyConfigEntry{
-						Kind: structs.ProxyDefaults,
+						Kind:     structs.ProxyDefaults,
-						Name: structs.ProxyConfigGlobal,
+						Name:     structs.ProxyConfigGlobal,
+						Protocol: "http2",
 						Config: map[string]interface{}{
 							"protocol": "http2",
 						},
@@ -104,8 +106,9 @@ func makeListenerDiscoChainTests(enterprise bool) []listenerTestCase {
 			create: func(t testinf.T) *proxycfg.ConfigSnapshot {
 				return proxycfg.TestConfigSnapshotDiscoveryChain(t, "simple", enterprise, nil, nil,
 					&structs.ProxyConfigEntry{
-						Kind: structs.ProxyDefaults,
+						Kind:     structs.ProxyDefaults,
-						Name: structs.ProxyConfigGlobal,
+						Name:     structs.ProxyConfigGlobal,
+						Protocol: "grpc",
 						Config: map[string]interface{}{
 							"protocol": "grpc",
 						},