Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions pkg/epp/handlers/server.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ import (
extProcPb "github.com/envoyproxy/go-control-plane/envoy/service/ext_proc/v3"
envoyTypePb "github.com/envoyproxy/go-control-plane/envoy/type/v3"
"github.com/go-logr/logr"
"github.com/google/uuid"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
"sigs.k8s.io/controller-runtime/pkg/log"
Expand Down Expand Up @@ -186,11 +187,18 @@ func (s *StreamingServer) Process(srv extProcPb.ExternalProcessor_ProcessServer)

switch v := req.Request.(type) {
case *extProcPb.ProcessingRequest_RequestHeaders:
if requestID := requtil.ExtractHeaderValue(v, requtil.RequestIdHeaderKey); len(requestID) > 0 {
logger = logger.WithValues(requtil.RequestIdHeaderKey, requestID)
loggerTrace = logger.V(logutil.TRACE)
ctx = log.IntoContext(ctx, logger)
requestID := requtil.ExtractHeaderValue(v, requtil.RequestIdHeaderKey)
// request ID is a must for maintaining a state per request in plugins that hold internal state and use PluginState.
// if request id was not supplied as a header, we generate it ourselves.
if len(requestID) == 0 {
requestID = uuid.NewString()
loggerTrace.Info("RequestID header is not found in the request, generated a request id")
reqCtx.Request.Headers[requtil.RequestIdHeaderKey] = requestID // update in headers so director can consume it
}
logger = logger.WithValues(requtil.RequestIdHeaderKey, requestID)
loggerTrace = logger.V(logutil.TRACE)
ctx = log.IntoContext(ctx, logger)

err = s.HandleRequestHeaders(reqCtx, v)
case *extProcPb.ProcessingRequest_RequestBody:
loggerTrace.Info("Incoming body chunk", "EoS", v.RequestBody.EndOfStream)
Expand Down
16 changes: 8 additions & 8 deletions pkg/epp/plugins/plugin_state.go
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ func NewPluginState(ctx context.Context) *PluginState {
// Note: PluginState uses a sync.Map to back the storage, because it is thread safe.
// It's aimed to optimize for the "write once and read many times" scenarios.
type PluginState struct {
// key: RequestID, value: map[StateKey]StateData
// key: RequestID, value: sync.Map[StateKey]StateData
storage sync.Map
// key: RequestID, value: time.Time
requestToLastAccessTime sync.Map
Expand All @@ -66,9 +66,9 @@ func (s *PluginState) Read(requestID string, key StateKey) (StateData, error) {
return nil, ErrNotFound
}

stateData := stateMap.(map[StateKey]StateData)
if value, ok := stateData[key]; ok {
return value, nil
stateData := stateMap.(*sync.Map)
if value, ok := stateData.Load(key); ok {
return value.(StateData), nil
}

return nil, ErrNotFound
Expand All @@ -77,15 +77,15 @@ func (s *PluginState) Read(requestID string, key StateKey) (StateData, error) {
// Write stores the given "val" in PluginState with the given "key" in the context of the given "requestID".
func (s *PluginState) Write(requestID string, key StateKey, val StateData) {
s.requestToLastAccessTime.Store(requestID, time.Now())
var stateData map[StateKey]StateData
var stateData *sync.Map
stateMap, ok := s.storage.Load(requestID)
if ok {
stateData = stateMap.(map[StateKey]StateData)
stateData = stateMap.(*sync.Map)
} else {
stateData = map[StateKey]StateData{}
stateData = &sync.Map{}
}

stateData[key] = val
stateData.Store(key, val)

s.storage.Store(requestID, stateData)
}
Expand Down
17 changes: 6 additions & 11 deletions pkg/epp/server/server_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,10 @@ const (
)

func TestServer(t *testing.T) {
theHeaderValue := "body"
requestHeader := "x-test"

expectedRequestHeaders := map[string]string{metadata.DestinationEndpointKey: fmt.Sprintf("%s:%d", podAddress, poolPort),
"Content-Length": "42", ":method": "POST", requestHeader: theHeaderValue}
expectedResponseHeaders := map[string]string{"x-went-into-resp-headers": "true", ":method": "POST", requestHeader: theHeaderValue}
expectedSchedulerHeaders := map[string]string{":method": "POST", requestHeader: theHeaderValue}
"Content-Length": "42", ":method": "POST", "x-test": "body", "x-request-id": "test-request-id"}
expectedResponseHeaders := map[string]string{"x-went-into-resp-headers": "true", ":method": "POST", "x-test": "body"}
expectedSchedulerHeaders := map[string]string{":method": "POST", "x-test": "body", "x-request-id": "test-request-id"}

t.Run("server", func(t *testing.T) {
model := testutil.MakeInferenceObjective("v1").
Expand All @@ -66,9 +63,10 @@ func TestServer(t *testing.T) {

// Send request headers - no response expected
headers := utils.BuildEnvoyGRPCHeaders(map[string]string{
requestHeader: theHeaderValue,
"x-test": "body",
":method": "POST",
metadata.FlowFairnessIDKey: "a-very-interesting-fairness-id",
"x-request-id": "test-request-id",
}, true)
request := &pb.ProcessingRequest{
Request: &pb.ProcessingRequest_RequestHeaders{
Expand Down Expand Up @@ -130,9 +128,6 @@ func TestServer(t *testing.T) {
}

// Check headers passed to the scheduler
if len(director.requestHeaders) != 2 {
t.Errorf("Incorrect number of request headers %d instead of 2", len(director.requestHeaders))
}
for expectedKey, expectedValue := range expectedSchedulerHeaders {
got, ok := director.requestHeaders[expectedKey]
if !ok {
Expand All @@ -143,7 +138,7 @@ func TestServer(t *testing.T) {
}

// Send response headers
headers = utils.BuildEnvoyGRPCHeaders(map[string]string{requestHeader: theHeaderValue, ":method": "POST"}, false)
headers = utils.BuildEnvoyGRPCHeaders(map[string]string{"x-test": "body", ":method": "POST"}, false)
request = &pb.ProcessingRequest{
Request: &pb.ProcessingRequest_ResponseHeaders{
ResponseHeaders: headers,
Expand Down
57 changes: 57 additions & 0 deletions test/integration/epp/hermetic_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ import (
"sigs.k8s.io/gateway-api-inference-extension/pkg/epp/scheduling/framework/plugins/scorer"
"sigs.k8s.io/gateway-api-inference-extension/pkg/epp/server"
logutil "sigs.k8s.io/gateway-api-inference-extension/pkg/epp/util/logging"
requtil "sigs.k8s.io/gateway-api-inference-extension/pkg/epp/util/request"
epptestutil "sigs.k8s.io/gateway-api-inference-extension/pkg/epp/util/testing"
integrationutils "sigs.k8s.io/gateway-api-inference-extension/test/integration"
)
Expand Down Expand Up @@ -187,6 +188,12 @@ func TestFullDuplexStreamed_KubeInferenceObjectiveRequest(t *testing.T) {
RawValue: []byte("mom"),
},
},
&configPb.HeaderValueOption{
Header: &configPb.HeaderValue{
Key: requtil.RequestIdHeaderKey,
RawValue: []byte("test-request-id"),
},
},
),
},
{
Expand Down Expand Up @@ -250,6 +257,12 @@ func TestFullDuplexStreamed_KubeInferenceObjectiveRequest(t *testing.T) {
RawValue: []byte("mom"),
},
},
&configPb.HeaderValueOption{
Header: &configPb.HeaderValue{
Key: requtil.RequestIdHeaderKey,
RawValue: []byte("test-request-id"),
},
},
),
},
{
Expand Down Expand Up @@ -279,6 +292,12 @@ func TestFullDuplexStreamed_KubeInferenceObjectiveRequest(t *testing.T) {
RawValue: []byte("mom"),
},
},
&configPb.HeaderValueOption{
Header: &configPb.HeaderValue{
Key: requtil.RequestIdHeaderKey,
RawValue: []byte("test-request-id"),
},
},
),
},
{
Expand Down Expand Up @@ -308,6 +327,12 @@ func TestFullDuplexStreamed_KubeInferenceObjectiveRequest(t *testing.T) {
RawValue: []byte("mom"),
},
},
&configPb.HeaderValueOption{
Header: &configPb.HeaderValue{
Key: requtil.RequestIdHeaderKey,
RawValue: []byte("test-request-id"),
},
},
),
},
{
Expand All @@ -330,6 +355,10 @@ func TestFullDuplexStreamed_KubeInferenceObjectiveRequest(t *testing.T) {
Key: metadata.ModelNameRewriteKey,
Value: modelSheddableTarget,
},
{
Key: requtil.RequestIdHeaderKey,
Value: "test-request-id",
},
},
},
},
Expand Down Expand Up @@ -368,6 +397,12 @@ func TestFullDuplexStreamed_KubeInferenceObjectiveRequest(t *testing.T) {
RawValue: []byte("mom"),
},
},
&configPb.HeaderValueOption{
Header: &configPb.HeaderValue{
Key: requtil.RequestIdHeaderKey,
RawValue: []byte("test-request-id"),
},
},
),
},
{
Expand All @@ -394,6 +429,10 @@ func TestFullDuplexStreamed_KubeInferenceObjectiveRequest(t *testing.T) {
Key: metadata.ModelNameRewriteKey,
Value: modelDirect,
},
{
Key: requtil.RequestIdHeaderKey,
Value: "test-request-id",
},
},
},
},
Expand Down Expand Up @@ -432,6 +471,12 @@ func TestFullDuplexStreamed_KubeInferenceObjectiveRequest(t *testing.T) {
RawValue: []byte("mom"),
},
},
&configPb.HeaderValueOption{
Header: &configPb.HeaderValue{
Key: requtil.RequestIdHeaderKey,
RawValue: []byte("test-request-id"),
},
},
),
},
// Response flow tests
Expand Down Expand Up @@ -778,6 +823,12 @@ func TestFullDuplexStreamed_KubeInferenceObjectiveRequest(t *testing.T) {
RawValue: []byte("mom"),
},
},
&configPb.HeaderValueOption{
Header: &configPb.HeaderValue{
Key: requtil.RequestIdHeaderKey,
RawValue: []byte("test-request-id"),
},
},
),
},
{
Expand Down Expand Up @@ -811,6 +862,12 @@ func TestFullDuplexStreamed_KubeInferenceObjectiveRequest(t *testing.T) {
RawValue: []byte("mom"),
},
},
&configPb.HeaderValueOption{
Header: &configPb.HeaderValue{
Key: requtil.RequestIdHeaderKey,
RawValue: []byte("test-request-id"),
},
},
),
},
{
Expand Down
5 changes: 5 additions & 0 deletions test/integration/util.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ import (

"sigs.k8s.io/gateway-api-inference-extension/pkg/epp/metadata"
logutil "sigs.k8s.io/gateway-api-inference-extension/pkg/epp/util/logging"
requtil "sigs.k8s.io/gateway-api-inference-extension/pkg/epp/util/request"
)

const (
Expand Down Expand Up @@ -130,6 +131,10 @@ func GenerateStreamedRequestSet(logger logr.Logger, prompt, model, targetModel s
Key: metadata.ModelNameRewriteKey,
Value: targetModel,
},
{
Key: requtil.RequestIdHeaderKey,
Value: "test-request-id",
},
},
},
},
Expand Down