use TypedName as private field, not embedded

Signed-off-by: Etai Lev Ran <elevran@gmail.com>

Author: elevran

conformance/testing-epp/plugins/filter/request_header_based_filter.go

@@ -40,13 +40,18 @@ var _ framework.Filter = &HeaderBasedTestingFilter{}
 // This should only be used for testing purposes.
 func NewHeaderBasedTestingFilter() *HeaderBasedTestingFilter {
 	return &HeaderBasedTestingFilter{
-		TypedName: plugins.TypedName{Type: "header-based-testing", Name: "header-based-testing-filter"},
+		tn: plugins.TypedName{Type: "header-based-testing", Name: "header-based-testing-filter"},
 	}
 }
 
 // HeaderBasedTestingFilter filters Pods based on an address specified in the "test-epp-endpoint-selection" request header.
 type HeaderBasedTestingFilter struct {
-	plugins.TypedName
+	tn plugins.TypedName
+}
+
+// TypedName returns the type and name tuple of this plugin instance.
+func (f *HeaderBasedTestingFilter) TypedName() plugins.TypedName {
+	return f.tn
 }
 
 // Filter selects pods that match the IP addresses specified in the request header.

pkg/epp/common/config/loader/configloader_test.go

@@ -555,16 +555,20 @@ schedulingProfiles:
 var _ framework.Filter = &test1{}
 
 type test1 struct {
-	plugins.TypedName
+	tn        plugins.TypedName
 	Threshold int `json:"threshold"`
 }
 
 func newTest1() *test1 {
 	return &test1{
-		TypedName: plugins.TypedName{Type: test1Type, Name: "test-1"},
+		tn: plugins.TypedName{Type: test1Type, Name: "test-1"},
 	}
 }
 
+func (f *test1) TypedName() plugins.TypedName {
+	return f.tn
+}
+
 // Filter filters out pods that doesn't meet the filter criteria.
 func (f *test1) Filter(_ context.Context, _ *types.CycleState, _ *types.LLMRequest, pods []types.Pod) []types.Pod {
 	return pods
@@ -575,15 +579,19 @@ var _ framework.Scorer = &test2{}
 var _ framework.PostCycle = &test2{}
 
 type test2 struct {
-	plugins.TypedName
+	tn plugins.TypedName
 }
 
 func newTest2() *test2 {
 	return &test2{
-		TypedName: plugins.TypedName{Type: test2Type, Name: "test-2"},
+		tn: plugins.TypedName{Type: test2Type, Name: "test-2"},
 	}
 }
 
+func (m *test2) TypedName() plugins.TypedName {
+	return m.tn
+}
+
 func (m *test2) Score(_ context.Context, _ *types.CycleState, _ *types.LLMRequest, _ []types.Pod) map[types.Pod]float64 {
 	return map[types.Pod]float64{}
 }
@@ -594,15 +602,19 @@ func (m *test2) PostCycle(_ context.Context, _ *types.CycleState, _ *types.Profi
 var _ framework.Picker = &testPicker{}
 
 type testPicker struct {
-	plugins.TypedName
+	tn plugins.TypedName
 }
 
 func newTestPicker() *testPicker {
 	return &testPicker{
-		TypedName: plugins.TypedName{Type: testPickerType, Name: "test-picker"},
+		tn: plugins.TypedName{Type: testPickerType, Name: "test-picker"},
 	}
 }
 
+func (p *testPicker) TypedName() plugins.TypedName {
+	return p.tn
+}
+
 func (p *testPicker) Pick(_ context.Context, _ *types.CycleState, _ []*types.ScoredPod) *types.ProfileRunResult {
 	return nil
 }
@@ -611,15 +623,19 @@ func (p *testPicker) Pick(_ context.Context, _ *types.CycleState, _ []*types.Sco
 var _ framework.ProfileHandler = &testProfileHandler{}
 
 type testProfileHandler struct {
-	plugins.TypedName
+	tn plugins.TypedName
 }
 
 func newTestProfileHandler() *testProfileHandler {
 	return &testProfileHandler{
-		TypedName: plugins.TypedName{Type: testProfileHandlerType, Name: "test-profile-handler"},
+		tn: plugins.TypedName{Type: testProfileHandlerType, Name: "test-profile-handler"},
 	}
 }
 
+func (p *testProfileHandler) TypedName() plugins.TypedName {
+	return p.tn
+}
+
 func (p *testProfileHandler) Pick(_ context.Context, _ *types.CycleState, _ *types.LLMRequest, _ map[string]*framework.SchedulerProfile, _ map[string]*types.ProfileRunResult) map[string]*framework.SchedulerProfile {
 	return nil
 }

pkg/epp/plugins/plugins.go

@@ -24,8 +24,8 @@ import (
 // Plugin defines the interface for a plugin.
 // This interface should be embedded in all plugins across the code.
 type Plugin interface {
-	// GetTypedName returns the type and name of this plugin instance.
-	GetTypedName() TypedName
+	// TypedName returns the type and name tuple of this plugin instance.
+	TypedName() TypedName
 }
 
 // Handle provides plugins a set of standard data and tools to work with

pkg/epp/plugins/typedname.go

@@ -36,7 +36,3 @@ const (
 func (tn *TypedName) String() string {
 	return tn.Type + Separator + tn.Name
 }
-
-func (tn *TypedName) GetTypedName() TypedName {
-	return *tn
-}

pkg/epp/requestcontrol/director.go

@@ -312,18 +312,18 @@ func RandomWeightedDraw(logger logr.Logger, model *v1alpha2.InferenceModel, seed
 func (d *Director) runPreRequestPlugins(ctx context.Context, request *schedulingtypes.LLMRequest, schedulingResult *schedulingtypes.SchedulingResult,
 	targetPort int) {
 	for _, plugin := range d.preRequestPlugins {
-		log.FromContext(ctx).V(logutil.DEBUG).Info("Running pre-request plugin", "plugin", plugin.GetTypedName().Type)
+		log.FromContext(ctx).V(logutil.DEBUG).Info("Running pre-request plugin", "plugin", plugin.TypedName().Type)
 		before := time.Now()
 		plugin.PreRequest(ctx, request, schedulingResult, targetPort)
-		metrics.RecordRequestControlPluginProcessingLatency(PreRequestPluginType, plugin.GetTypedName().Type, time.Since(before))
+		metrics.RecordRequestControlPluginProcessingLatency(PreRequestPluginType, plugin.TypedName().Type, time.Since(before))
 	}
 }
 
 func (d *Director) runPostResponsePlugins(ctx context.Context, request *schedulingtypes.LLMRequest, response *Response, targetPod *backend.Pod) {
 	for _, plugin := range d.postResponsePlugins {
-		log.FromContext(ctx).V(logutil.DEBUG).Info("Running post-response plugin", "plugin", plugin.GetTypedName().Type)
+		log.FromContext(ctx).V(logutil.DEBUG).Info("Running post-response plugin", "plugin", plugin.TypedName().Type)
 		before := time.Now()
 		plugin.PostResponse(ctx, request, response, targetPod)
-		metrics.RecordRequestControlPluginProcessingLatency(PostResponsePluginType, plugin.GetTypedName().Type, time.Since(before))
+		metrics.RecordRequestControlPluginProcessingLatency(PostResponsePluginType, plugin.TypedName().Type, time.Since(before))
 	}
 }

pkg/epp/requestcontrol/director_test.go

@@ -695,17 +695,21 @@ const (
 )
 
 type testPostResponse struct {
-	plugins.TypedName
+	tn                      plugins.TypedName
 	lastRespOnResponse      *Response
 	lastTargetPodOnResponse string
 }
 
 func newTestPostResponse(name string) *testPostResponse {
 	return &testPostResponse{
-		TypedName: plugins.TypedName{Type: testPostResponseType, Name: name},
+		tn: plugins.TypedName{Type: testPostResponseType, Name: name},
 	}
 }
 
+func (p *testPostResponse) TypedName() plugins.TypedName {
+	return p.tn
+}
+
 func (p *testPostResponse) PostResponse(_ context.Context, _ *schedulingtypes.LLMRequest, response *Response, targetPod *backend.Pod) {
 	p.lastRespOnResponse = response
 	p.lastTargetPodOnResponse = targetPod.NamespacedName.String()

pkg/epp/scheduling/framework/plugins/filter/decision_tree_filter.go

@@ -133,14 +133,14 @@ func loadDecisionTreeEntry(entry *decisionTreeFilterEntry, handle plugins.Handle
 	return nil, errors.New("either pluginRef or decisionTree must be specified")
 }
 
-func (f *DecisionTreeFilter) GetTypedName() plugins.TypedName {
+func (f *DecisionTreeFilter) TypedName() plugins.TypedName {
 	if f == nil {
 		// TODO: this keeps the previous behavior ("nil"/"") - not sure
 		// why done this way.
 		// Change to empty TypedName or some more meaningful values?
 		return plugins.TypedName{Type: "nil", Name: ""}
 	}
-	return f.Current.GetTypedName()
+	return f.Current.TypedName()
 }
 
 // Filter filters out pods that doesn't meet the filter criteria.
@@ -157,7 +157,7 @@ func (f *DecisionTreeFilter) Filter(ctx context.Context, cycleState *types.Cycle
 		if f.NextOnSuccess != nil {
 			next = f.NextOnSuccess
 		}
-		loggerTrace.Info("Filter succeeded", "filter", f.GetTypedName(), "next", next.GetTypedName(), "filteredPodCount", len(filteredPod))
+		loggerTrace.Info("Filter succeeded", "filter", f.TypedName(), "next", next.TypedName(), "filteredPodCount", len(filteredPod))
 		// On success, pass the filtered result to the next filter.
 		return next.Filter(ctx, cycleState, request, filteredPod)
 	} else {
@@ -168,7 +168,7 @@ func (f *DecisionTreeFilter) Filter(ctx context.Context, cycleState *types.Cycle
 		if f.NextOnFailure != nil {
 			next = f.NextOnFailure
 		}
-		loggerTrace.Info("Filter failed", "filter", f.GetTypedName(), "next", next.GetTypedName())
+		loggerTrace.Info("Filter failed", "filter", f.TypedName(), "next", next.TypedName())
 		// On failure, pass the initial set of pods to the next filter.
 		return next.Filter(ctx, cycleState, request, pods)
 	}

pkg/epp/scheduling/framework/plugins/filter/filter_test.go

@@ -40,12 +40,16 @@ import (
 var _ framework.Filter = &filterAll{}
 
 type filterAll struct {
-	plugins.TypedName
+	tn plugins.TypedName
+}
+
+func (f *filterAll) TypedName() plugins.TypedName {
+	return f.tn
 }
 
 func newFilterAll() *filterAll {
 	return &filterAll{
-		TypedName: plugins.TypedName{Type: "filter-all", Name: "test-all"},
+		tn: plugins.TypedName{Type: "filter-all", Name: "test-all"},
 	}
 }
 

pkg/epp/scheduling/framework/plugins/filter/least_kvcache_filter.go

@@ -41,7 +41,7 @@ func LeastKVCacheFilterFactory(name string, _ json.RawMessage, _ plugins.Handle)
 // NewLeastKVCacheFilter initializes a new LeastKVCacheFilter and returns its pointer.
 func NewLeastKVCacheFilter() *LeastKVCacheFilter {
 	return &LeastKVCacheFilter{
-		TypedName: plugins.TypedName{Type: LeastKVCacheFilterType, Name: LeastKVCacheFilterType},
+		tn: plugins.TypedName{Type: LeastKVCacheFilterType, Name: LeastKVCacheFilterType},
 	}
 }
 
@@ -51,12 +51,17 @@ func NewLeastKVCacheFilter() *LeastKVCacheFilter {
 // should consider them all instead of the absolute minimum one. This worked better than picking the
 // least one as it gives more choices for the next filter, which on aggregate gave better results.
 type LeastKVCacheFilter struct {
-	plugins.TypedName
+	tn plugins.TypedName
+}
+
+// TypedName returns the type and name tuple of this plugin instance.
+func (f *LeastKVCacheFilter) TypedName() plugins.TypedName {
+	return f.tn
 }
 
 // WithName sets the name of the filter.
 func (f *LeastKVCacheFilter) WithName(name string) *LeastKVCacheFilter {
-	f.Name = name
+	f.tn.Name = name
 	return f
 }
 

pkg/epp/scheduling/framework/plugins/filter/least_queue_filter.go

@@ -41,7 +41,7 @@ func LeastQueueFilterFactory(name string, _ json.RawMessage, _ plugins.Handle) (
 // NewLeastQueueFilter initializes a new LeastQueueFilter and returns its pointer.
 func NewLeastQueueFilter() *LeastQueueFilter {
 	return &LeastQueueFilter{
-		TypedName: plugins.TypedName{Type: LeastQueueFilterType, Name: LeastQueueFilterType},
+		tn: plugins.TypedName{Type: LeastQueueFilterType, Name: LeastQueueFilterType},
 	}
 }
 
@@ -51,12 +51,17 @@ func NewLeastQueueFilter() *LeastQueueFilter {
 // we should consider them all instead of the absolute minimum one. This worked better than picking
 // the least one as it gives more choices for the next filter, which on aggregate gave better results.
 type LeastQueueFilter struct {
-	plugins.TypedName
+	tn plugins.TypedName
+}
+
+// TypedName returns the type and name tuple of this plugin instance.
+func (f *LeastQueueFilter) TypedName() plugins.TypedName {
+	return f.tn
 }
 
 // WithName sets the name of the filter.
 func (f *LeastQueueFilter) WithName(name string) *LeastQueueFilter {
-	f.Name = name
+	f.tn.Name = name
 	return f
 }