NET-6945 - Replace usage of deprecated Envoy field envoy.config.core.…

…v3.HeaderValueOption.append (hashicorp#20078) * NET-6945 - Replace usage of deprecated Envoy field envoy.config.core.v3.HeaderValueOption.append * update proto for v2 and then update xds v2 logic * add changelog * Update 20078.txt to be consistent with existing changelog entries * swap enum values tomatch envoy.
amplify-education · Jan 4, 2024 · 7a410d7 · 7a410d7
1 parent 55d7e95
commit 7a410d7
Show file tree

Hide file tree

Showing 15 changed files with 101 additions and 97 deletions.
diff --git a/.changelog/20078.txt b/.changelog/20078.txt
@@ -0,0 +1,3 @@
+```release-note:improvement
+connect: Replace usage of deprecated Envoy field `envoy.config.core.v3.HeaderValueOption.append`.
+```
diff --git a/agent/xds/routes.go b/agent/xds/routes.go
@@ -534,7 +534,10 @@ func makeHeadersValueOptions(vals map[string]string, add bool) []*envoy_core_v3.
 				Key:   k,
 				Value: v,
 			},
-			Append: response.MakeBoolValue(add),
+		}
+		if !add {
+			// default is APPEND_IF_EXISTS_OR_ADD
+			o.AppendAction = envoy_core_v3.HeaderValueOption_OVERWRITE_IF_EXISTS_OR_ADD
 		}
 		opts = append(opts, o)
 	}
@@ -1130,6 +1133,7 @@ func injectLBToRouteAction(lb *structs.LoadBalancer, action *envoy_route_v3.Rout
 }
 
 func injectHeaderManipToRoute(dest *structs.ServiceRouteDestination, r *envoy_route_v3.Route) error {
+
 	if !dest.RequestHeaders.IsZero() {
 		r.RequestHeadersToAdd = append(
 			r.RequestHeadersToAdd,

diff --git a/agent/xds/testdata/routes/api-gateway-with-http-route-timeoutfilter-one-set.latest.golden b/agent/xds/testdata/routes/api-gateway-with-http-route-timeoutfilter-one-set.latest.golden
@@ -19,14 +19,13 @@
               },
               "requestHeadersToAdd": [
                 {
-                  "append": true,
                   "header": {
                     "key": "X-Header-Add",
                     "value": "added"
                   }
                 },
                 {
-                  "append": false,
+                  "appendAction": "OVERWRITE_IF_EXISTS_OR_ADD",
                   "header": {
                     "key": "X-Header-Set",
                     "value": "set"

diff --git a/agent/xds/testdata/routes/api-gateway-with-http-route.latest.golden b/agent/xds/testdata/routes/api-gateway-with-http-route.latest.golden
@@ -19,14 +19,13 @@
               },
               "requestHeadersToAdd": [
                 {
-                  "append": true,
                   "header": {
                     "key": "X-Header-Add",
                     "value": "added"
                   }
                 },
                 {
-                  "append": false,
+                  "appendAction": "OVERWRITE_IF_EXISTS_OR_ADD",
                   "header": {
                     "key": "X-Header-Set",
                     "value": "set"

diff --git a/agent/xds/testdata/routes/connect-proxy-splitter-overweight.latest.golden b/agent/xds/testdata/routes/connect-proxy-splitter-overweight.latest.golden
@@ -23,7 +23,7 @@
                       "name": "big-side.default.dc1.internal.11111111-2222-3333-4444-555555555555.consul",
                       "requestHeadersToAdd": [
                         {
-                          "append": false,
+                          "appendAction": "OVERWRITE_IF_EXISTS_OR_ADD",
                           "header": {
                             "key": "x-split-leg",
                             "value": "big"
@@ -32,7 +32,7 @@
                       ],
                       "responseHeadersToAdd": [
                         {
-                          "append": false,
+                          "appendAction": "OVERWRITE_IF_EXISTS_OR_ADD",
                           "header": {
                             "key": "x-split-leg",
                             "value": "big"
@@ -45,7 +45,7 @@
                       "name": "goldilocks-side.default.dc1.internal.11111111-2222-3333-4444-555555555555.consul",
                       "requestHeadersToAdd": [
                         {
-                          "append": false,
+                          "appendAction": "OVERWRITE_IF_EXISTS_OR_ADD",
                           "header": {
                             "key": "x-split-leg",
                             "value": "goldilocks"
@@ -54,7 +54,7 @@
                       ],
                       "responseHeadersToAdd": [
                         {
-                          "append": false,
+                          "appendAction": "OVERWRITE_IF_EXISTS_OR_ADD",
                           "header": {
                             "key": "x-split-leg",
                             "value": "goldilocks"
@@ -67,7 +67,7 @@
                       "name": "lil-bit-side.default.dc1.internal.11111111-2222-3333-4444-555555555555.consul",
                       "requestHeadersToAdd": [
                         {
-                          "append": false,
+                          "appendAction": "OVERWRITE_IF_EXISTS_OR_ADD",
                           "header": {
                             "key": "x-split-leg",
                             "value": "small"
@@ -76,7 +76,7 @@
                       ],
                       "responseHeadersToAdd": [
                         {
-                          "append": false,
+                          "appendAction": "OVERWRITE_IF_EXISTS_OR_ADD",
                           "header": {
                             "key": "x-split-leg",
                             "value": "small"

diff --git a/agent/xds/testdata/routes/connect-proxy-with-chain-and-router.latest.golden b/agent/xds/testdata/routes/connect-proxy-with-chain-and-router.latest.golden
@@ -369,14 +369,13 @@
               },
               "requestHeadersToAdd": [
                 {
-                  "append": true,
                   "header": {
                     "key": "request",
                     "value": "bar"
                   }
                 },
                 {
-                  "append": false,
+                  "appendAction": "OVERWRITE_IF_EXISTS_OR_ADD",
                   "header": {
                     "key": "bar",
                     "value": "baz"
@@ -388,14 +387,13 @@
               ],
               "responseHeadersToAdd": [
                 {
-                  "append": true,
                   "header": {
                     "key": "response",
                     "value": "bar"
                   }
                 },
                 {
-                  "append": false,
+                  "appendAction": "OVERWRITE_IF_EXISTS_OR_ADD",
                   "header": {
                     "key": "bar",
                     "value": "baz"

diff --git a/agent/xds/testdata/routes/connect-proxy-with-chain-and-splitter.latest.golden b/agent/xds/testdata/routes/connect-proxy-with-chain-and-splitter.latest.golden
@@ -41,7 +41,7 @@
                       "name": "db.default.dc1.internal.11111111-2222-3333-4444-555555555555.consul",
                       "requestHeadersToAdd": [
                         {
-                          "append": false,
+                          "appendAction": "OVERWRITE_IF_EXISTS_OR_ADD",
                           "header": {
                             "key": "x-split-leg",
                             "value": "db"
@@ -50,7 +50,7 @@
                       ],
                       "responseHeadersToAdd": [
                         {
-                          "append": false,
+                          "appendAction": "OVERWRITE_IF_EXISTS_OR_ADD",
                           "header": {
                             "key": "x-split-leg",
                             "value": "db"
@@ -63,7 +63,7 @@
                       "name": "big-side.default.dc1.internal.11111111-2222-3333-4444-555555555555.consul",
                       "requestHeadersToAdd": [
                         {
-                          "append": false,
+                          "appendAction": "OVERWRITE_IF_EXISTS_OR_ADD",
                           "header": {
                             "key": "x-split-leg",
                             "value": "big"
@@ -72,7 +72,7 @@
                       ],
                       "responseHeadersToAdd": [
                         {
-                          "append": false,
+                          "appendAction": "OVERWRITE_IF_EXISTS_OR_ADD",
                           "header": {
                             "key": "x-split-leg",
                             "value": "big"
@@ -85,7 +85,7 @@
                       "name": "goldilocks-side.default.dc1.internal.11111111-2222-3333-4444-555555555555.consul",
                       "requestHeadersToAdd": [
                         {
-                          "append": false,
+                          "appendAction": "OVERWRITE_IF_EXISTS_OR_ADD",
                           "header": {
                             "key": "x-split-leg",
                             "value": "goldilocks"
@@ -94,7 +94,7 @@
                       ],
                       "responseHeadersToAdd": [
                         {
-                          "append": false,
+                          "appendAction": "OVERWRITE_IF_EXISTS_OR_ADD",
                           "header": {
                             "key": "x-split-leg",
                             "value": "goldilocks"
@@ -107,7 +107,7 @@
                       "name": "lil-bit-side.default.dc1.internal.11111111-2222-3333-4444-555555555555.consul",
                       "requestHeadersToAdd": [
                         {
-                          "append": false,
+                          "appendAction": "OVERWRITE_IF_EXISTS_OR_ADD",
                           "header": {
                             "key": "x-split-leg",
                             "value": "small"
@@ -116,7 +116,7 @@
                       ],
                       "responseHeadersToAdd": [
                         {
-                          "append": false,
+                          "appendAction": "OVERWRITE_IF_EXISTS_OR_ADD",
                           "header": {
                             "key": "x-split-leg",
                             "value": "small"

diff --git a/agent/xds/testdata/routes/ingress-with-chain-and-router-header-manip.latest.golden b/agent/xds/testdata/routes/ingress-with-chain-and-router-header-manip.latest.golden
@@ -14,14 +14,13 @@
           "name": "db",
           "requestHeadersToAdd": [
             {
-              "append": true,
               "header": {
                 "key": "foo",
                 "value": "bar"
               }
             },
             {
-              "append": false,
+              "appendAction": "OVERWRITE_IF_EXISTS_OR_ADD",
               "header": {
                 "key": "bar",
                 "value": "baz"
@@ -33,14 +32,13 @@
           ],
           "responseHeadersToAdd": [
             {
-              "append": true,
               "header": {
                 "key": "foo",
                 "value": "bar"
               }
             },
             {
-              "append": false,
+              "appendAction": "OVERWRITE_IF_EXISTS_OR_ADD",
               "header": {
                 "key": "bar",
                 "value": "baz"
@@ -408,14 +406,13 @@
               },
               "requestHeadersToAdd": [
                 {
-                  "append": true,
                   "header": {
                     "key": "request",
                     "value": "bar"
                   }
                 },
                 {
-                  "append": false,
+                  "appendAction": "OVERWRITE_IF_EXISTS_OR_ADD",
                   "header": {
                     "key": "bar",
                     "value": "baz"
@@ -427,14 +424,13 @@
               ],
               "responseHeadersToAdd": [
                 {
-                  "append": true,
                   "header": {
                     "key": "response",
                     "value": "bar"
                   }
                 },
                 {
-                  "append": false,
+                  "appendAction": "OVERWRITE_IF_EXISTS_OR_ADD",
                   "header": {
                     "key": "bar",
                     "value": "baz"

diff --git a/agent/xds/testdata/routes/ingress-with-chain-and-router.latest.golden b/agent/xds/testdata/routes/ingress-with-chain-and-router.latest.golden
@@ -370,14 +370,13 @@
               },
               "requestHeadersToAdd": [
                 {
-                  "append": true,
                   "header": {
                     "key": "request",
                     "value": "bar"
                   }
                 },
                 {
-                  "append": false,
+                  "appendAction": "OVERWRITE_IF_EXISTS_OR_ADD",
                   "header": {
                     "key": "bar",
                     "value": "baz"
@@ -389,14 +388,13 @@
               ],
               "responseHeadersToAdd": [
                 {
-                  "append": true,
                   "header": {
                     "key": "response",
                     "value": "bar"
                   }
                 },
                 {
-                  "append": false,
+                  "appendAction": "OVERWRITE_IF_EXISTS_OR_ADD",
                   "header": {
                     "key": "bar",
                     "value": "baz"

diff --git a/agent/xds/testdata/routes/ingress-with-chain-and-splitter.latest.golden b/agent/xds/testdata/routes/ingress-with-chain-and-splitter.latest.golden
@@ -42,7 +42,7 @@
                       "name": "db.default.dc1.internal.11111111-2222-3333-4444-555555555555.consul",
                       "requestHeadersToAdd": [
                         {
-                          "append": false,
+                          "appendAction": "OVERWRITE_IF_EXISTS_OR_ADD",
                           "header": {
                             "key": "x-split-leg",
                             "value": "db"
@@ -51,7 +51,7 @@
                       ],
                       "responseHeadersToAdd": [
                         {
-                          "append": false,
+                          "appendAction": "OVERWRITE_IF_EXISTS_OR_ADD",
                           "header": {
                             "key": "x-split-leg",
                             "value": "db"
@@ -64,7 +64,7 @@
                       "name": "big-side.default.dc1.internal.11111111-2222-3333-4444-555555555555.consul",
                       "requestHeadersToAdd": [
                         {
-                          "append": false,
+                          "appendAction": "OVERWRITE_IF_EXISTS_OR_ADD",
                           "header": {
                             "key": "x-split-leg",
                             "value": "big"
@@ -73,7 +73,7 @@
                       ],
                       "responseHeadersToAdd": [
                         {
-                          "append": false,
+                          "appendAction": "OVERWRITE_IF_EXISTS_OR_ADD",
                           "header": {
                             "key": "x-split-leg",
                             "value": "big"
@@ -86,7 +86,7 @@
                       "name": "goldilocks-side.default.dc1.internal.11111111-2222-3333-4444-555555555555.consul",
                       "requestHeadersToAdd": [
                         {
-                          "append": false,
+                          "appendAction": "OVERWRITE_IF_EXISTS_OR_ADD",
                           "header": {
                             "key": "x-split-leg",
                             "value": "goldilocks"
@@ -95,7 +95,7 @@
                       ],
                       "responseHeadersToAdd": [
                         {
-                          "append": false,
+                          "appendAction": "OVERWRITE_IF_EXISTS_OR_ADD",
                           "header": {
                             "key": "x-split-leg",
                             "value": "goldilocks"
@@ -108,7 +108,7 @@
                       "name": "lil-bit-side.default.dc1.internal.11111111-2222-3333-4444-555555555555.consul",
                       "requestHeadersToAdd": [
                         {
-                          "append": false,
+                          "appendAction": "OVERWRITE_IF_EXISTS_OR_ADD",
                           "header": {
                             "key": "x-split-leg",
                             "value": "small"
@@ -117,7 +117,7 @@
                       ],
                       "responseHeadersToAdd": [
                         {
-                          "append": false,
+                          "appendAction": "OVERWRITE_IF_EXISTS_OR_ADD",
                           "header": {
                             "key": "x-split-leg",
                             "value": "small"