internal/delegatingresolver: avoid proxy if networktype of target address is not tcp #8215

eshitachandwani · 2025-04-02T05:32:28Z

RELEASE NOTES:

Proxy connections are no longer attempted for targets with non-TCP network types.

codecov · 2025-04-02T07:08:46Z

Codecov Report

Attention: Patch coverage is 74.13793% with 15 lines in your changes missing coverage. Please review.

Project coverage is 82.16%. Comparing base (5edab9e) to head (d254b04).
Report is 12 commits behind head on master.

Files with missing lines	Patch %	Lines
.../resolver/delegatingresolver/delegatingresolver.go	74.13%	13 Missing and 2 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #8215      +/-   ##
==========================================
- Coverage   82.17%   82.16%   -0.02%     
==========================================
  Files         410      412       +2     
  Lines       40236    40536     +300     
==========================================
+ Hits        33065    33306     +241     
- Misses       5822     5863      +41     
- Partials     1349     1367      +18

Files with missing lines	Coverage Δ
.../resolver/delegatingresolver/delegatingresolver.go	`79.11% <74.13%> (-3.12%)`	⬇️

... and 45 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

arjan-bal · 2025-04-02T10:37:35Z

internal/resolver/delegatingresolver/delegatingresolver.go

+	if len(curState.Endpoints) != 0 {
+		networkType, ok = networktype.Get(curState.Endpoints[0].Addresses[0])
+	} else {
+		networkType, ok = networktype.Get(curState.Addresses[0])
+	}


Here we're making an assumption that the network type of the first address of the endpoint is the same the address type of all remaining addresses. This may be true for most real-world usecases, but it isn't a requirement specified in the resolver API. It should not be too difficult to avoid proxying on a per-address basis. There are two places below where we do the following, one for resolver.State.Addresses and once for resolver.State.Endpoints:

proxyattributes.Set(proxyAddr, proxyattributes.Options{ User: r.proxyURL.User, ConnectAddr: targetAddr.Addr, })

We can refactor this into a method that takes in the target address and proxy address and returns the combined address.

fn (r *delegatingResolver) combineAddresses(targetAddr, proxyAddr resolver.Address) resolver.Address { if networktype.Get(targetAddr) != "tcp" { return targetAddr } return proxyattributes.Set(proxyAddr, proxyattributes.Options{ User: r.proxyURL.User, ConnectAddr: targetAddr.Addr, }) }

The above comment end up adding duplicate addresses in the loop on targetResolverState.Endpoints. We will probably need to invert the loop on r.proxyAddrs and endpt.Addresses and break early:

for _, endpt := range (*r.targetResolverState).Endpoints { var addrs []resolver.Address for _, targetAddr := range endpt.Addresses { if networktype.Get(targetAddr) != "tcp" { addrs = append(addrs, targetAddr) continue } for _, proxyAddr := range r.proxyAddrs { addrs = append(addrs, proxyattributes.Set(proxyAddr, proxyattributes.Options{ User: r.proxyURL.User, ConnectAddr: targetAddr.Addr, })) } } endpoints = append(endpoints, resolver.Endpoint{Addresses: addrs}) }

Right, done ! Also added a check in beginning , if there is not address with network type TCP , we do not wait for proxy update and just update the cc state.

arjan-bal · 2025-04-02T10:38:28Z

Please also fix the format of the release notes.

arjan-bal · 2025-04-08T04:29:17Z

internal/resolver/delegatingresolver/delegatingresolver.go

+		if networkType, ok := networktype.Get(addr); !ok || networkType == "tcp" {
+			isTCP = true
+			break
+		}


Out here we're assuming !ok to be the same of tcp. However, the old code in the dialer used to parse the address string when !ok to determine the network type, we should probably maintain the same behaviour.

grpc-go/internal/transport/http2_client.go

Lines 177 to 182 in 172fc5b

if !ok {

networkType, address = parseDialTarget(address)

}

if networkType == "tcp" && useProxy {

return proxyDial(ctx, address, grpcUA)

}

arjan-bal · 2025-04-08T04:37:12Z

internal/resolver/delegatingresolver/delegatingresolver.go

+			if networkType, ok := networktype.Get(addr); !ok || networkType == "tcp" || isTCP {
+				isTCP = true
+				break
+			}


I think the code will be simpler if we refactor finding a TCP address in a helper function. The helper function can return early instead of keeping track of a isTCP boolean and breaking out of nested loops.

Right! Done!

arjan-bal · 2025-04-08T04:38:06Z

internal/resolver/delegatingresolver/delegatingresolver.go

+		} else {
+			addresses = append(addresses, proxyattributes.Set(proxyAddr, proxyattributes.Options{
+				User:        r.proxyURL.User,
+				ConnectAddr: targetAddr.Addr,
+			}))
+		}


nit: You can use continue in the if block to avoid indenting the else block.

arjan-bal · 2025-04-08T04:38:15Z

internal/resolver/delegatingresolver/delegatingresolver.go

+			} else {
+				for _, proxyAddr := range r.proxyAddrs {
+					addrs = append(addrs, proxyattributes.Set(proxyAddr, proxyattributes.Options{
+						User:        r.proxyURL.User,
+						ConnectAddr: targetAddr.Addr,
+					}))
+				}
 			}


nit: You can use continue in the if block to avoid indenting the else block.

easwars · 2025-04-11T17:25:51Z

internal/resolver/delegatingresolver/delegatingresolver.go

 // updateClientConnStateLocked creates a list of combined addresses by
 // pairing each proxy address with every target address. For each pair, it
 // generates a new [resolver.Address] using the proxy address, and adding the
 // target address as the attribute along with user info. It returns nil if
 // either resolver has not sent update even once and returns the error from
 // ClientConn update once both resolvers have sent update atleast once.
 func (r *delegatingResolver) updateClientConnStateLocked() error {
-	if r.targetResolverState == nil || r.proxyAddrs == nil {
+	if r.targetResolverState == nil {


If r.proxyAddrs == nil is no longer in this conditional, does it mean that we can have a case where the proxy is configured, but we don't end up waiting for the resolved proxy addresses here?

easwars · 2025-04-11T17:26:43Z

internal/resolver/delegatingresolver/delegatingresolver.go

 		return nil
 	}

 	curState := *r.targetResolverState
+
+	// If no addresses returned by resolver have network type as tcp , do not wait for proxy update.


Nit: Please wrap comment lines at 80-cols. See: go/go-style/decisions#comment-line-length

easwars · 2025-04-11T17:30:15Z

internal/resolver/delegatingresolver/delegatingresolver.go

 // updateClientConnStateLocked creates a list of combined addresses by
 // pairing each proxy address with every target address. For each pair, it
 // generates a new [resolver.Address] using the proxy address, and adding the
 // target address as the attribute along with user info. It returns nil if
 // either resolver has not sent update even once and returns the error from
 // ClientConn update once both resolvers have sent update atleast once.
 func (r *delegatingResolver) updateClientConnStateLocked() error {
-	if r.targetResolverState == nil || r.proxyAddrs == nil {
+	if r.targetResolverState == nil {
 		return nil
 	}

 	curState := *r.targetResolverState


Even though we have this local variable curState, I see that the code (both existing and newly added) also uses r.targetResolverState in multiple places. Can we make it consistent and use only one of them.

easwars · 2025-04-11T17:39:33Z

internal/resolver/delegatingresolver/delegatingresolver.go

+		return r.cc.UpdateState(curState)
+	}
+
+	if r.proxyAddrs == nil {


Ah, I see that the previous check is moved here.

easwars · 2025-04-11T17:48:50Z

internal/resolver/delegatingresolver/delegatingresolver_ext_test.go

+	}
+
+	// Verify that the state clientconn receives is same as updated by target resolver,
+	// since we want to avoid proxy for any network type aprt from tcp.


Nit: typo "aprt"

easwars · 2025-04-11T17:51:57Z

internal/resolver/delegatingresolver/delegatingresolver_ext_test.go

+	case <-time.After(defaultTestShortTimeout):
+		t.Fatalf("Delegating resolver did not call update state")
+	}


Can this be racy, especially on some slow GitHub action machines? We generally use defaultTestShortTimeout for things that we expect to not happen. We do expect a state update here. So, I would rather use defaultTestTimeout here and validate the state received on stateCh.

easwars · 2025-04-11T17:52:32Z

internal/resolver/delegatingresolver/delegatingresolver_ext_test.go

+	}
+}
+
+// Tests the scenario where a proxy is configured, and the resolver returns addresses with varied


Nit: Same here. Please wrap comments at 80-cols. Please figure out a way to configure your editor to do this for you.

easwars · 2025-04-11T17:53:46Z

internal/resolver/delegatingresolver/delegatingresolver_ext_test.go

+	const (
+		targetTestAddr          = "test.target"
+		resolvedTargetTestAddr1 = "1.1.1.1:8080"
+		resolvedTargetTestAddr2 = "2.2.2.2:8080"


This is not used. Please delete.

easwars · 2025-04-11T17:54:43Z

internal/resolver/delegatingresolver/delegatingresolver_ext_test.go

+		resolvedProxyTestAddr1  = "11.11.11.11:7687"
+		resolvedProxyTestAddr2  = "22.22.22.22:7687"


These two are not used. Please delete.

no proxy if not tcp

751dd5e

eshitachandwani added the Type: Bug label Apr 2, 2025

eshitachandwani added this to the 1.72 Release milestone Apr 2, 2025

eshitachandwani added the Area: Resolvers/Balancers Includes LB policy & NR APIs, resolver/balancer/picker wrappers, LB policy impls and utilities. label Apr 2, 2025

eshitachandwani added 2 commits April 2, 2025 11:12

endpoint check

4476246

passing tests

39d3ded

eshitachandwani and others added 4 commits April 2, 2025 14:18

test

fcbc507

correct test

618877a

Merge branch 'master' into d_error

d150d8e

merge conflicts

325e8cb

eshitachandwani added Type: Bug and removed Type: Bug labels Apr 2, 2025

eshitachandwani requested a review from arjan-bal April 2, 2025 09:53

eshitachandwani assigned arjan-bal Apr 2, 2025

arjan-bal reviewed Apr 2, 2025

View reviewed changes

arjan-bal assigned eshitachandwani and unassigned arjan-bal Apr 2, 2025

eshitachandwani modified the milestones: 1.72 Release, 1.73 Release Apr 3, 2025

eshitachandwani added 3 commits April 7, 2025 12:16

check

f2a6133

var change

8742ea7

var change

607ec91

eshitachandwani requested a review from arjan-bal April 7, 2025 08:07

eshitachandwani assigned arjan-bal and unassigned eshitachandwani Apr 7, 2025

arjan-bal reviewed Apr 8, 2025

View reviewed changes

arjan-bal assigned eshitachandwani and unassigned arjan-bal Apr 8, 2025

refactor

d254b04

eshitachandwani requested review from arjan-bal and easwars April 11, 2025 12:16

eshitachandwani assigned easwars and arjan-bal and unassigned eshitachandwani Apr 11, 2025

easwars reviewed Apr 11, 2025

View reviewed changes

easwars assigned eshitachandwani and unassigned easwars and arjan-bal Apr 11, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

internal/delegatingresolver: avoid proxy if networktype of target address is not tcp #8215

internal/delegatingresolver: avoid proxy if networktype of target address is not tcp #8215

eshitachandwani commented Apr 2, 2025 •

edited

Loading

codecov bot commented Apr 2, 2025 •

edited

Loading

arjan-bal Apr 2, 2025

arjan-bal Apr 2, 2025

eshitachandwani Apr 7, 2025

arjan-bal commented Apr 2, 2025

arjan-bal Apr 8, 2025

eshitachandwani Apr 11, 2025

arjan-bal Apr 8, 2025

eshitachandwani Apr 11, 2025

arjan-bal Apr 8, 2025

eshitachandwani Apr 11, 2025

arjan-bal Apr 8, 2025

eshitachandwani Apr 11, 2025

easwars Apr 11, 2025

easwars Apr 11, 2025

easwars Apr 11, 2025

easwars Apr 11, 2025

easwars Apr 11, 2025

easwars Apr 11, 2025

easwars Apr 11, 2025

easwars Apr 11, 2025

easwars Apr 11, 2025

	if !ok {
	networkType, address = parseDialTarget(address)
	}
	if networkType == "tcp" && useProxy {
	return proxyDial(ctx, address, grpcUA)
	}

		resolvedProxyTestAddr1 = "11.11.11.11:7687"
		resolvedProxyTestAddr2 = "22.22.22.22:7687"

internal/delegatingresolver: avoid proxy if networktype of target address is not tcp #8215

Are you sure you want to change the base?

internal/delegatingresolver: avoid proxy if networktype of target address is not tcp #8215

Conversation

eshitachandwani commented Apr 2, 2025 • edited Loading

codecov bot commented Apr 2, 2025 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

arjan-bal commented Apr 2, 2025

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

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

eshitachandwani commented Apr 2, 2025 •

edited

Loading

codecov bot commented Apr 2, 2025 •

edited

Loading