balancer: Enforce embedding the SubConn interface in implementations (#…

…7758)
grpc · Nov 5, 2024 · 43ee172 · 43ee172
1 parent 2de6df9
commit 43ee172
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 0 deletions.
diff --git a/balancer/balancer.go b/balancer/balancer.go
@@ -155,6 +155,9 @@ type SubConn interface {
 	// indicate the shutdown operation.  This may be delivered before
 	// in-progress RPCs are complete and the actual connection is closed.
 	Shutdown()
+	// enforceEmbedding is an unexported method to force implementers embed
+	// this interface, allowing gRPC to add methods without breaking users.
+	enforceEmbedding()
 }
 
 // NewSubConnOptions contains options to create new SubConn.

diff --git a/balancer/base/balancer_test.go b/balancer/base/balancer_test.go
@@ -41,6 +41,7 @@ func (c *testClientConn) NewSubConn(addrs []resolver.Address, opts balancer.NewS
 func (c *testClientConn) UpdateState(balancer.State) {}
 
 type testSubConn struct {
+	balancer.SubConn
 	updateState func(balancer.SubConnState)
 }
 

diff --git a/balancer_wrapper.go b/balancer_wrapper.go
@@ -254,6 +254,7 @@ func (ccb *ccBalancerWrapper) Target() string {
 // acBalancerWrapper is a wrapper on top of ac for balancers.
 // It implements balancer.SubConn interface.
 type acBalancerWrapper struct {
+	balancer.SubConn
 	ac            *addrConn          // read-only
 	ccb           *ccBalancerWrapper // read-only
 	stateListener func(balancer.SubConnState)

diff --git a/internal/testutils/balancer.go b/internal/testutils/balancer.go
@@ -32,6 +32,7 @@ import (
 
 // TestSubConn implements the SubConn interface, to be used in tests.
 type TestSubConn struct {
+	balancer.SubConn
 	tcc           *BalancerClientConn // the CC that owns this SubConn
 	id            string
 	ConnectCh     chan struct{}