Implement multiplexer proxy. #2141

zyjhtangtang · 2024-08-28T12:31:34Z

What type of PR is this?

/kind feature

What this PR does / why we need it:

Implement the shared cache module in node-level traffic multiplexing, referencing the Design Proposal.

Does this PR introduce a user-facing change?

"NONE"

codecov · 2024-08-28T13:08:55Z

Codecov Report

Attention: Patch coverage is 48.54142% with 441 lines in your changes missing coverage. Please review.

Project coverage is 45.28%. Comparing base (7763e7c) to head (a3d603c).
Report is 45 commits behind head on master.

Files with missing lines	Patch %	Lines
.../yurthub/proxy/multiplexer/watchembeddedencoder.go	10.66%	130 Missing and 4 partials ⚠️
pkg/yurthub/proxy/multiplexer/multiplexerwatch.go	51.21%	43 Missing and 17 partials ⚠️
pkg/yurthub/multiplexer/storage/fake_storage.go	0.00%	49 Missing ⚠️
pkg/yurthub/proxy/multiplexer/multiplexerlist.go	51.42%	19 Missing and 15 partials ⚠️
pkg/yurthub/proxy/multiplexer/multiplexerproxy.go	72.95%	21 Missing and 12 partials ⚠️
pkg/yurthub/multiplexer/manager.go	73.33%	10 Missing and 10 partials ⚠️
pkg/yurthub/proxy/util/util.go	0.00%	19 Missing ⚠️
pkg/yurthub/proxy/proxy.go	0.00%	14 Missing ⚠️
pkg/yurthub/filter/interfaces.go	0.00%	13 Missing ⚠️
pkg/yurthub/filter/manager/manager.go	0.00%	10 Missing ⚠️
... and 12 more

Additional details and impacted files

@@             Coverage Diff             @@
##           master    #2141        /-   ##
===========================================
- Coverage   58.93%   45.28%   -13.65%     
===========================================
  Files         210      420       210     
  Lines       18968    28631      9663     
===========================================
  Hits        11179    12966      1787     
- Misses       6707    14367      7660     
- Partials     1082     1298       216

Flag	Coverage Δ
unittests	`45.28% <48.54%> (-13.65%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

pkg/yurthub/types/constants.go

pkg/yurthub/types/types.go

pkg/yurthub/sharecache/cache.go

sonarqubecloud · 2024-09-14T07:49:40Z

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

pkg/yurthub/multiplexer/manager.go

pkg/yurthub/multiplexer/storage/store.go

pkg/yurthub/multiplexer/manager.go

rambohe-ch · 2024-11-23T12:57:29Z

pkg/yurthub/util/util.go

@@ -86,13  86,15 @@ const (
 	CacheUserAgentsKey    = "cache_agents"
 	PoolScopeResourcesKey = "pool_scope_resources"

+	MultiplexerProxyClientUserAgent = "multiplexer-proxy"


how about name MultiplexerProxyClientUserAgent to fmt.Sprintf("multiplexer-proxy-%s", strings.ToLower(nodeName))?

rambohe-ch · 2024-11-23T13:02:20Z

pkg/yurthub/multiplexer/storage/manager.go

+}
+
+func (sm *storageManager) restClient(gvr *schema.GroupVersionResource) (rest.Interface, error) {
+	httpClient, _ := rest.HTTPClientFor(sm.config)


I think we should not skip err here

rambohe-ch · 2024-11-23T13:25:58Z

pkg/yurthub/multiplexer/storage/manager.go

+		return nil, errors.Wrapf(err, "failed to get rest client for %v", gvr)
+	}
+
+	rs := &store{


rs := NewStore(restClient, gvr.Resource)

pkg/yurthub/multiplexer/storage/store.go

rambohe-ch · 2024-12-23T06:08:26Z

cmd/yurthub/app/config/config.go

 	"github.com/openyurtio/openyurt/pkg/yurthub/network"
 	"github.com/openyurtio/openyurt/pkg/yurthub/storage/disk"
 	"github.com/openyurtio/openyurt/pkg/yurthub/util"
 )

+var DefaultMultiplexerResources = []schema.GroupVersionResource{


DefaultMultiplexerResources --> AllowedMultiplexerResources

rambohe-ch · 2024-12-23T06:09:03Z

cmd/yurthub/app/config/config.go

@@ -101,6  117,9 @@ type YurtHubConfiguration struct {
 	CoordinatorClient               kubernetes.Interface
 	LeaderElection                  componentbaseconfig.LeaderElectionConfiguration
 	HostControlPlaneAddr            string // ip:port
+	PostStartHooks                  map[string]func() error
+	MultiplexerCacheManager         multiplexer.MultiplexerManager


MultiplexerCacheManager --> RequestMultiplexerManager

pkg/yurthub/filter/interfaces.go

rambohe-ch · 2024-12-23T06:32:04Z

pkg/yurthub/filter/interfaces.go

 type NodeGetter func(name string) (*v1.Node, error)
+
+type UnionObjectFilter []ObjectFilter


It seems that we can use filterChain instead of defining a new UnionObjectFilter.

openyurt/pkg/yurthub/filter/responsefilter/filter.go

Line 217 in 2432e74

type filterChain []filter.ObjectFilter

by the way, maybe you can create a new folder named objectfilter and move filterchain into this folder.

@zyjhtangtang please remove UnionObjectFilter

sonarqubecloud · 2024-12-23T12:23:11Z

Quality Gate passed

Issues
7 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
1.6% Duplication on New Code

See analysis details on SonarQube Cloud

rambohe-ch · 2024-12-23T23:03:56Z

pkg/yurthub/filter/interfaces.go

@@ -59,4  59,11 @@ type ObjectFilter interface {
 	Filter(obj runtime.Object, stopCh <-chan struct{}) runtime.Object
 }

+type FilterManager interface {


how about rename FilterManager to FilterFinder?

rambohe-ch · 2024-12-23T23:34:16Z

pkg/yurthub/proxy/util/util.go

+
+	if info.Verb != "list" && info.Verb != "watch" {
+		return false
+	}


we also need to exclude requests with fieldSelector or labelSelector.

rambohe-ch · 2024-12-23T23:44:04Z

pkg/yurthub/proxy/multiplexer/multiplexerproxy.go

+		sp.multiplexerList(w, r, gvr)
+	case "watch":
+		sp.multiplexerWatch(w, r, gvr)
+	}


please add default case, like only support list/watch requests.

rambohe-ch · 2024-12-23T23:50:42Z

pkg/yurthub/multiplexer/storage/manager.go

+
+type storageManager struct {
+	config     *rest.Config
+	storageMap map[string]storage.Interface


storageMap --> gvrToStorage

rambohe-ch · 2024-12-23T23:58:50Z

pkg/yurthub/multiplexer/manager.go

+		restStoreManager:    restStoreManager,
+		restMapper:          kmeta.NewDefaultRESTMapperFromScheme(),
+		cacheMap:            make(map[string]Interface),
+		cacheConfigMap:      make(map[string]*ResourceCacheConfig),


cacheConfigMap --> gvrToCacheConfig

rambohe-ch · 2024-12-24T00:00:00Z

pkg/yurthub/multiplexer/manager.go

+	return &multiplexerManager{
+		restStoreManager:    restStoreManager,
+		restMapper:          kmeta.NewDefaultRESTMapperFromScheme(),
+		cacheMap:            make(map[string]Interface),


cacheMap --> gvrToCache

rambohe-ch · 2024-12-24T00:01:02Z

pkg/yurthub/multiplexer/manager.go

+		restMapper:          kmeta.NewDefaultRESTMapperFromScheme(),
+		cacheMap:            make(map[string]Interface),
+		cacheConfigMap:      make(map[string]*ResourceCacheConfig),
+		cacheDestroyFuncMap: make(map[string]func()),


cacheDestroyFuncMap --> gvrToCacheDestroyFunc

rambohe-ch · 2024-12-24T00:02:11Z

pkg/yurthub/multiplexer/manager.go

+	}
+}
+func (m *multiplexerManager) ResourceCacheConfig(gvr *schema.GroupVersionResource) (*ResourceCacheConfig, error) {
+	if config, ok := m.cacheConfigMap[gvr.String()]; ok {


Maybe we need to add a sync lock for cacheConfigMap in order to get rid of race conditioning.

rambohe-ch · 2024-12-24T00:30:20Z

pkg/yurthub/proxy/multiplexer/multiplexerlist.go

+}
+
+func (sp *multiplexerProxy) filterListObject(obj runtime.Object, filter filter.ObjectFilter) (runtime.Object, error) {
+	if filter == nil {


filter may not be nil because of it is a filter.ObjectFilter. so please use yurtutil.IsNil() func to verify.

zyjhtangtang force-pushed the master branch from dc8ef68 to 9c6ddfa Compare August 28, 2024 13:03

zyjhtangtang force-pushed the master branch from 9c6ddfa to e49d50f Compare August 28, 2024 13:09

rambohe-ch reviewed Aug 29, 2024

View reviewed changes

pkg/yurthub/types/constants.go Outdated Show resolved Hide resolved

rambohe-ch reviewed Aug 29, 2024

View reviewed changes

pkg/yurthub/types/types.go Outdated Show resolved Hide resolved

rambohe-ch reviewed Aug 29, 2024

View reviewed changes

pkg/yurthub/sharecache/cache.go Outdated Show resolved Hide resolved

zyjhtangtang force-pushed the master branch 3 times, most recently from 44acb84 to 8ecdab1 Compare September 14, 2024 07:49

rambohe-ch reviewed Oct 20, 2024

View reviewed changes

pkg/yurthub/multiplexer/manager.go Outdated Show resolved Hide resolved

rambohe-ch reviewed Oct 20, 2024

View reviewed changes

pkg/yurthub/multiplexer/manager.go Outdated Show resolved Hide resolved

rambohe-ch reviewed Oct 20, 2024

View reviewed changes

pkg/yurthub/multiplexer/storage/store.go Show resolved Hide resolved

zyjhtangtang force-pushed the master branch 2 times, most recently from 4171c61 to aed7925 Compare October 21, 2024 07:32

rambohe-ch reviewed Oct 21, 2024

View reviewed changes

pkg/yurthub/multiplexer/manager.go Show resolved Hide resolved

zyjhtangtang force-pushed the master branch from aed7925 to b388a3b Compare November 13, 2024 13:02

zyjhtangtang changed the title ~~Implement shared cache.~~ Implement multiplexer proxy. Nov 13, 2024

zyjhtangtang force-pushed the master branch 3 times, most recently from 4f1ad5f to d6c4a47 Compare November 14, 2024 01:34

rambohe-ch reviewed Nov 23, 2024

View reviewed changes

zyjhtangtang force-pushed the master branch from d6c4a47 to 2be0ec2 Compare November 23, 2024 13:08

rambohe-ch reviewed Nov 23, 2024

View reviewed changes

pkg/yurthub/multiplexer/storage/store.go Show resolved Hide resolved

Implement multi plexer cache.

f2e07f0

zyjhtangtang force-pushed the master branch 2 times, most recently from a2f0237 to a3d603c Compare December 4, 2024 09:08

rambohe-ch reviewed Dec 23, 2024

View reviewed changes

pkg/yurthub/filter/interfaces.go Show resolved Hide resolved

rambohe-ch reviewed Dec 23, 2024

View reviewed changes

add multiplexer proxy.

53a4bbb

zyjhtangtang force-pushed the master branch from a3d603c to 53a4bbb Compare December 23, 2024 12:22

zyjhtangtang requested a review from a team as a code owner December 23, 2024 12:22

rambohe-ch reviewed Dec 23, 2024

View reviewed changes

rambohe-ch reviewed Dec 24, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement multiplexer proxy. #2141

Implement multiplexer proxy. #2141

zyjhtangtang commented Aug 28, 2024

codecov bot commented Aug 28, 2024 •

edited

Loading

sonarqubecloud bot commented Sep 14, 2024

rambohe-ch Nov 23, 2024

zyjhtangtang Dec 3, 2024 •

edited

Loading

rambohe-ch Nov 23, 2024

zyjhtangtang Dec 3, 2024

rambohe-ch Nov 23, 2024

zyjhtangtang Dec 3, 2024

rambohe-ch Dec 23, 2024

zyjhtangtang Dec 23, 2024

rambohe-ch Dec 23, 2024

zyjhtangtang Dec 23, 2024

rambohe-ch Dec 23, 2024

zyjhtangtang Dec 23, 2024

rambohe-ch Dec 23, 2024

sonarqubecloud bot commented Dec 23, 2024

rambohe-ch Dec 23, 2024

rambohe-ch Dec 23, 2024

rambohe-ch Dec 23, 2024

rambohe-ch Dec 23, 2024

rambohe-ch Dec 23, 2024

rambohe-ch Dec 24, 2024

rambohe-ch Dec 24, 2024

rambohe-ch Dec 24, 2024

rambohe-ch Dec 24, 2024

		type NodeGetter func(name string) (*v1.Node, error)

		type UnionObjectFilter []ObjectFilter

Implement multiplexer proxy. #2141

Are you sure you want to change the base?

Implement multiplexer proxy. #2141

Conversation

zyjhtangtang commented Aug 28, 2024

What type of PR is this?

What this PR does / why we need it:

Does this PR introduce a user-facing change?

codecov bot commented Aug 28, 2024 • edited Loading

Codecov Report

sonarqubecloud bot commented Sep 14, 2024

Quality Gate passed

Choose a reason for hiding this comment

zyjhtangtang Dec 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Dec 23, 2024

Quality Gate passed

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Aug 28, 2024 •

edited

Loading

zyjhtangtang Dec 3, 2024 •

edited

Loading