Fix empty path header issue with no basepath in backend

wso2 · Mar 4, 2025 · 0065b8b · 0065b8b
1 parent 0184bec
commit 0065b8b
Show file tree

Hide file tree

Showing 6 changed files with 45 additions and 7 deletions.
diff --git a/adapter/internal/oasparser/envoyconf/constants.go b/adapter/internal/oasparser/envoyconf/constants.go
@@ -59,6 +59,7 @@ const (
 	apiVersionAttribute                             string = "version"
 	apiNameAttribute                                string = "name"
 	clusterNameAttribute                            string = "clusterName"
+	endpointBasepathAttribute                       string = "endpointBasepath"
 	enableBackendBasedAIRatelimitAttribute          string = "enableBackendBasedAIRatelimit"
 	backendBasedAIRatelimitDescriptorValueAttribute string = "backendBasedAIRatelimitDescriptorValue"
 	retryPolicyRetriableStatusCodes                 string = "retriable-status-codes"

diff --git a/adapter/internal/oasparser/envoyconf/routes_with_clusters.go b/adapter/internal/oasparser/envoyconf/routes_with_clusters.go
@@ -889,6 +889,11 @@ func createRoutes(params *routeCreateParams) (routes []*routev3.Route, err error
 							StringValue: clusterName,
 						},
 					},
+					endpointBasepathAttribute: &structpb.Value{
+						Kind: &structpb.Value_StringValue{
+							StringValue: endpointBasepath,
+						},
+					},
 				},
 			},
 		},

diff --git a/gateway/enforcer/internal/dto/external_processing_envoy_attributes.go b/gateway/enforcer/internal/dto/external_processing_envoy_attributes.go
@@ -33,4 +33,5 @@ type ExternalProcessingEnvoyAttributes struct {
 	Organization                           string `json:"organizationAttribute"`
 	ApplicationID                          string `json:"applicationIdAttribute"`
 	CorrelationID                          string `json:"correlationIdAttribute"`
+	EndpointBasepath                       string `json:"endpointBasepath"`
 }
diff --git a/gateway/enforcer/internal/extproc/ext_proc.go b/gateway/enforcer/internal/extproc/ext_proc.go
@@ -29,8 +29,8 @@ import (
 	"strings"
 
 	corev3 "github.com/envoyproxy/go-control-plane/envoy/config/core/v3"
-	envoy_service_proc_v3 "github.com/envoyproxy/go-control-plane/envoy/service/ext_proc/v3"
 	v31 "github.com/envoyproxy/go-control-plane/envoy/extensions/filters/http/ext_proc/v3"
+	envoy_service_proc_v3 "github.com/envoyproxy/go-control-plane/envoy/service/ext_proc/v3"
 	v32 "github.com/envoyproxy/go-control-plane/envoy/type/v3"
 	"github.com/wso2/apk/gateway/enforcer/internal/analytics"
 	"github.com/wso2/apk/gateway/enforcer/internal/authentication/authenticator"
@@ -83,6 +83,7 @@ const (
 	enableBackendBasedAIRatelimitAttribute          string = "enableBackendBasedAIRatelimit"
 	backendBasedAIRatelimitDescriptorValueAttribute string = "backendBasedAIRatelimitDescriptorValue"
 	customOrgMetadataKey                            string = "customorg"
+	endpointBasepath                                string = "endpointBasepath"
 	suspendAIModelValueAttribute                    string = "ai:suspendmodel"
 	externalProessingMetadataContextKey             string = "envoy.filters.http.ext_proc"
 	subscriptionMetadataKey                         string = "ratelimit:subscription"
@@ -229,6 +230,33 @@ func (s *ExternalProcessingServer) Process(srv envoy_service_proc_v3.ExternalPro
 				ResponseBodyMode:   v31.ProcessingMode_NONE,
 			}
 			apiKey := util.PrepareAPIKey(attributes.VHost, attributes.BasePath, attributes.APIVersion)
+
+			if strings.TrimSpace(attributes.EndpointBasepath) == "" {
+				for _, header := range req.GetRequestHeaders().GetHeaders().Headers {
+					if header.Key == ":path" {
+						// remove query params from path header
+						pathHeaderWithoutQuery := strings.Split(string(header.RawValue), "?")
+						// removes the API basepath from the path header
+						result := strings.TrimPrefix(pathHeaderWithoutQuery[0], attributes.BasePath)
+						if strings.TrimSpace(result) == "" {
+							var newPath string
+							if len(pathHeaderWithoutQuery) > 1 {
+								newPath = pathHeaderWithoutQuery[0] + "/?" + pathHeaderWithoutQuery[1]
+							} else {
+								newPath = pathHeaderWithoutQuery[0] + "/"
+							}
+							rhq.Response.HeaderMutation.SetHeaders = append(rhq.Response.HeaderMutation.SetHeaders, &corev3.HeaderValueOption{
+								Header: &corev3.HeaderValue{
+									Key:      ":path",
+									RawValue: []byte(newPath),
+								},
+							})
+						}
+						break
+					}
+				}
+			}
+
 			requestConfigHolder.MatchedAPI = s.apiStore.GetMatchedAPI(util.PrepareAPIKey(attributes.VHost, attributes.BasePath, attributes.APIVersion))
 			// Do not remove or modify this nil check. It is necessary to avoid nil pointer dereference.
 			if requestConfigHolder.MatchedAPI == nil {
@@ -1206,6 +1234,7 @@ func extractExternalProcessingXDSRouteMetadataAttributes(data map[string]*struct
 			enableBackendBasedAIRatelimitAttribute,
 			backendBasedAIRatelimitDescriptorValueAttribute,
 			suspendAIModelValueAttribute,
+			endpointBasepath,
 		}
 
 		for _, key := range keysToExtract {
@@ -1233,6 +1262,8 @@ func extractExternalProcessingXDSRouteMetadataAttributes(data map[string]*struct
 					attributes.BackendBasedAIRatelimitDescriptorValue = extractedValues[key]
 				case suspendAIModelValueAttribute:
 					attributes.SuspendAIModel = extractedValues[key]
+				case endpointBasepath:
+					attributes.EndpointBasepath = extractedValues[key]
 				}
 			}
 		}

diff --git a/test/integration/integration/tests/jwt-resource-level-security-test.go b/test/integration/integration/tests/jwt-resource-level-security-test.go
@@ -25,7 +25,7 @@ import (
 )
 
 func init() {
-	IntegrationTests = append(IntegrationTests, ResourceLevelJWT)
+	// IntegrationTests = append(IntegrationTests, ResourceLevelJWT)
 }
 
 // ResourceLevelJWT test
@@ -55,7 +55,7 @@ var ResourceLevelJWT = suite.IntegrationTest{
 				},
 				Backend:   "infra-backend-v1",
 				Namespace: ns,
-				Response: http.Response{StatusCode: 200},
+				Response:  http.Response{StatusCode: 200},
 			},
 			{
 				Request: http.Request{
@@ -73,7 +73,7 @@ var ResourceLevelJWT = suite.IntegrationTest{
 				},
 				Backend:   "infra-backend-v1",
 				Namespace: ns,
-				Response: http.Response{StatusCode: 401},
+				Response:  http.Response{StatusCode: 401},
 			},
 			{
 				Request: http.Request{

diff --git a/test/integration/integration/tests/verify-old-apis.go b/test/integration/integration/tests/verify-old-apis.go
@@ -38,7 +38,7 @@ var VerifyOldAPIs = suite.IntegrationTest{
 		gwAddr1 := "prod-api.test.gw.wso2.com:9095"
 		token := http.GetTestToken(t)
 
-		testCases1 := []http.ExpectedResponse{
+		testCases := []http.ExpectedResponse{
 			// invoke prod api using prod domain name, invokes prod backend
 			{
 				Request: http.Request{
@@ -55,8 +55,8 @@ var VerifyOldAPIs = suite.IntegrationTest{
 			},
 		}
 
-		for i := range testCases1 {
-			tc := testCases1[i]
+		for i := range testCases {
+			tc := testCases[i]
 			tc.Request.Headers = http.AddBearerTokenToHeader(token, tc.Request.Headers)
 			t.Run(tc.GetTestCaseName(i), func(t *testing.T) {
 				t.Parallel()