-
Notifications
You must be signed in to change notification settings - Fork 4.6k
delegatingresolver: add default port to addresses #8613
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from 8 commits
4186a66
2156251
07add50
abc1773
0702e0c
2f50b78
aee0066
3d93bc1
80a3e98
c19e88d
82076ed
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -22,11 +22,13 @@ package delegatingresolver | |
|
||
import ( | ||
"fmt" | ||
"net" | ||
"net/http" | ||
"net/url" | ||
"sync" | ||
|
||
"google.golang.org/grpc/grpclog" | ||
"google.golang.org/grpc/internal/envconfig" | ||
"google.golang.org/grpc/internal/proxyattributes" | ||
"google.golang.org/grpc/internal/transport" | ||
"google.golang.org/grpc/internal/transport/networktype" | ||
|
@@ -40,6 +42,8 @@ var ( | |
HTTPSProxyFromEnvironment = http.ProxyFromEnvironment | ||
) | ||
|
||
const defaultPort = "443" | ||
|
||
// delegatingResolver manages both target URI and proxy address resolution by | ||
// delegating these tasks to separate child resolvers. Essentially, it acts as | ||
// an intermediary between the gRPC ClientConn and the child resolvers. | ||
|
@@ -107,10 +111,13 @@ func New(target resolver.Target, cc resolver.ClientConn, opts resolver.BuildOpti | |
targetResolver: nopResolver{}, | ||
} | ||
|
||
var err error | ||
r.proxyURL, err = proxyURLForTarget(target.Endpoint()) | ||
addr, err := parseTarget(target.Endpoint()) | ||
if err != nil { | ||
return nil, fmt.Errorf("delegating_resolver: invalid target address %q: %v", target.Endpoint(), err) | ||
} | ||
|
||
r.proxyURL, err = proxyURLForTarget(addr) | ||
if err != nil { | ||
return nil, fmt.Errorf("delegating_resolver: failed to determine proxy URL for target %s: %v", target, err) | ||
return nil, fmt.Errorf("delegating_resolver: failed to determine proxy URL for target %q: %v", target, err) | ||
} | ||
|
||
// proxy is not configured or proxy address excluded using `NO_PROXY` env | ||
|
@@ -131,9 +138,13 @@ func New(target resolver.Target, cc resolver.ClientConn, opts resolver.BuildOpti | |
// resolution should be handled by the proxy, not the client. Therefore, we | ||
// bypass the target resolver and store the unresolved target address. | ||
if target.URL.Scheme == "dns" && !targetResolutionEnabled { | ||
addr := target.Endpoint() | ||
arjan-bal marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
if envconfig.AddDefaultPort { | ||
addr = maybeAddDefaultPort(target.Endpoint(), defaultPort) | ||
} | ||
r.targetResolverState = &resolver.State{ | ||
Addresses: []resolver.Address{{Addr: target.Endpoint()}}, | ||
Endpoints: []resolver.Endpoint{{Addresses: []resolver.Address{{Addr: target.Endpoint()}}}}, | ||
Addresses: []resolver.Address{{Addr: addr}}, | ||
Endpoints: []resolver.Endpoint{{Addresses: []resolver.Address{{Addr: addr}}}}, | ||
} | ||
r.updateTargetResolverState(*r.targetResolverState) | ||
return r, nil | ||
|
@@ -202,6 +213,34 @@ func needsProxyResolver(state *resolver.State) bool { | |
return false | ||
} | ||
|
||
func parseTarget(target string) (string, error) { | ||
host, port, err := net.SplitHostPort(target) | ||
if err != nil { | ||
return target, nil | ||
} | ||
if port == "" { | ||
// If the port field is empty (target ends with colon), e.g. "[::1]:", | ||
// this is an error. | ||
return "", fmt.Errorf("missing port after port-separator colon") | ||
} | ||
// target has port, i.e ipv4-host:port, [ipv6-host]:port, host-name:port | ||
if host == "" { | ||
// Keep consistent with net.Dial(): If the host is empty, as in ":80", | ||
// the local system is assumed. | ||
host = "localhost" | ||
} | ||
return net.JoinHostPort(host, port), nil | ||
} | ||
|
||
func maybeAddDefaultPort(target, defaultPort string) string { | ||
if _, _, err := net.SplitHostPort(target); err == nil { | ||
// target already has port | ||
return target | ||
} | ||
return net.JoinHostPort(target, defaultPort) | ||
|
||
} | ||
|
||
func skipProxy(address resolver.Address) bool { | ||
// Avoid proxy when network is not tcp. | ||
networkType, ok := networktype.Get(address) | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -23,10 +23,12 @@ import ( | |
"errors" | ||
"net/http" | ||
"net/url" | ||
"strings" | ||
"testing" | ||
"time" | ||
|
||
"github.com/google/go-cmp/cmp" | ||
"google.golang.org/grpc/internal/envconfig" | ||
"google.golang.org/grpc/internal/grpctest" | ||
"google.golang.org/grpc/internal/proxyattributes" | ||
"google.golang.org/grpc/internal/resolver/delegatingresolver" | ||
|
@@ -246,17 +248,111 @@ func (s) TestDelegatingResolverwithDNSAndProxyWithTargetResolution(t *testing.T) | |
} | ||
} | ||
|
||
// Tests the scenario where a proxy is configured, the target URI contains the | ||
// "dns" scheme, and target resolution is disabled(default behavior). The test | ||
// verifies that the addresses returned by the delegating resolver include the | ||
// proxy resolver's addresses, with the unresolved target URI as an attribute | ||
// of the proxy address. | ||
// TestDelegatingResolverWithProxy tests the creation of a delegating resolver | ||
arjan-bal marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
// when a proxy is configured. It verifies both successful creation for valid | ||
// targets and correct error handling for invalid ones. | ||
// | ||
// For successful cases, it ensures the final address is from the proxy resolver | ||
// and contains the original, correctly-formatted target address as an | ||
// attribute. | ||
func (s) TestDelegatingResolverwithDNSAndProxyWithNoTargetResolution(t *testing.T) { | ||
const ( | ||
envProxyAddr = "proxytest.com" | ||
resolvedProxyTestAddr1 = "11.11.11.11:7687" | ||
) | ||
tests := []struct { | ||
name string | ||
target string | ||
wantConnectAddress string | ||
wantErrorSubstring string | ||
|
||
}{ | ||
{ | ||
name: "no port in target", | ||
|
||
target: "test.com", | ||
wantConnectAddress: "test.com:443", | ||
}, | ||
{ | ||
name: "port specified in target", | ||
target: "test.com:8080", | ||
wantConnectAddress: "test.com:8080", | ||
}, | ||
{ | ||
name: "colon after host in target but no post", | ||
target: "test.com:", | ||
wantErrorSubstring: "missing port after port-separator colon", | ||
}, | ||
} | ||
|
||
for _, test := range tests { | ||
t.Run(test.name, func(t *testing.T) { | ||
overrideTestHTTPSProxy(t, envProxyAddr) | ||
|
||
targetResolver := manual.NewBuilderWithScheme("dns") | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Don't you have to unregister the original |
||
target := targetResolver.Scheme() + ":///" + test.target | ||
// Set up a manual DNS resolver to control the proxy address resolution. | ||
proxyResolver, proxyResolverBuilt := setupDNS(t) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Oh I see that this helper does re-register the original There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is what we had earlier too..in the tests. |
||
|
||
tcc, stateCh, _ := createTestResolverClientConn(t) | ||
_, err := delegatingresolver.New(resolver.Target{URL: *testutils.MustParseURL(target)}, tcc, resolver.BuildOptions{}, targetResolver, false) | ||
if test.wantErrorSubstring != "" { | ||
// Case 1: We expected an error. | ||
if err == nil { | ||
t.Fatalf("Delegating resolver created, want error containing %q", test.wantErrorSubstring) | ||
} | ||
if !strings.Contains(err.Error(), test.wantErrorSubstring) { | ||
t.Fatalf("Delegating resolver failed with error %q, want error containing %q", err.Error(), test.wantErrorSubstring) | ||
arjan-bal marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
} | ||
// Expected error was found, so the test case for this part is done. | ||
eshitachandwani marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
return | ||
} | ||
|
||
// Case 2: We did NOT expect an error. | ||
if err != nil { | ||
t.Fatalf("Delegating resolver creation failed unexpectedly with error: %v", err) | ||
} | ||
ctx, cancel := context.WithTimeout(context.Background(), defaultTestTimeout) | ||
defer cancel() | ||
|
||
// Wait for the proxy resolver to be built before calling UpdateState. | ||
mustBuildResolver(ctx, t, proxyResolverBuilt) | ||
proxyResolver.UpdateState(resolver.State{ | ||
Addresses: []resolver.Address{ | ||
{Addr: resolvedProxyTestAddr1}, | ||
}, | ||
}) | ||
|
||
wantState := resolver.State{ | ||
Addresses: []resolver.Address{proxyAddressWithTargetAttribute(resolvedProxyTestAddr1, test.wantConnectAddress)}, | ||
Endpoints: []resolver.Endpoint{{Addresses: []resolver.Address{proxyAddressWithTargetAttribute(resolvedProxyTestAddr1, test.wantConnectAddress)}}}, | ||
} | ||
|
||
var gotState resolver.State | ||
select { | ||
case gotState = <-stateCh: | ||
case <-ctx.Done(): | ||
t.Fatal("Context timed out when waiting for a state update from the delegating resolver") | ||
} | ||
|
||
if diff := cmp.Diff(gotState, wantState); diff != "" { | ||
t.Fatalf("Unexpected state from delegating resolver. Diff (-got +want):\n%v", diff) | ||
} | ||
}) | ||
} | ||
} | ||
|
||
// Tests the scenario where a proxy is configured, the target URI scheme is | ||
// "dns", target resolution is disabled, and the environment variable to add | ||
// default port is disabled. The test verifies that the addresses returned by | ||
// the delegating resolver include the resolved proxy address and the unresolved | ||
// target address without a port as attributes of the proxy address. | ||
func (s) TestDelegatingResolverEnvVarForDefaultPortDisabled(t *testing.T) { | ||
const ( | ||
targetTestAddr = "test.com" | ||
envProxyAddr = "proxytest.com" | ||
resolvedProxyTestAddr1 = "11.11.11.11:7687" | ||
) | ||
|
||
testutils.SetEnvConfig(t, &envconfig.AddDefaultPort, false) | ||
overrideTestHTTPSProxy(t, envProxyAddr) | ||
|
||
targetResolver := manual.NewBuilderWithScheme("dns") | ||
|
Uh oh!
There was an error while loading. Please reload this page.