Browse Source

fix: jsonrpc url parsing and dial function (#6264) (#6288)

This PR fixes how the jsonrpc parses the URL, and how the dial function connects to the RPC.

Closes: https://github.com/tendermint/tendermint/issues/6260

(cherry picked from commit 9ecfcc93a6)

Co-authored-by: Frojdi Dymylja <33157909+fdymylja@users.noreply.github.com>
pull/6294/head
mergify[bot] 4 years ago
committed by GitHub
parent
commit
b7a4d5e7ba
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 81 additions and 3 deletions
  1. +31
    -3
      rpc/jsonrpc/client/http_json_client.go
  2. +50
    -0
      rpc/jsonrpc/client/http_json_client_test.go

+ 31
- 3
rpc/jsonrpc/client/http_json_client.go View File

@ -21,6 +21,7 @@ const (
protoWSS = "wss" protoWSS = "wss"
protoWS = "ws" protoWS = "ws"
protoTCP = "tcp" protoTCP = "tcp"
protoUNIX = "unix"
) )
//------------------------------------------------------------- //-------------------------------------------------------------
@ -28,6 +29,8 @@ const (
// Parsed URL structure // Parsed URL structure
type parsedURL struct { type parsedURL struct {
url.URL url.URL
isUnixSocket bool
} }
// Parse URL and set defaults // Parse URL and set defaults
@ -42,7 +45,16 @@ func newParsedURL(remoteAddr string) (*parsedURL, error) {
u.Scheme = protoTCP u.Scheme = protoTCP
} }
return &parsedURL{*u}, nil
pu := &parsedURL{
URL: *u,
isUnixSocket: false,
}
if u.Scheme == protoUNIX {
pu.isUnixSocket = true
}
return pu, nil
} }
// Change protocol to HTTP for unknown protocols and TCP protocol - useful for RPC connections // Change protocol to HTTP for unknown protocols and TCP protocol - useful for RPC connections
@ -65,10 +77,26 @@ func (u parsedURL) GetHostWithPath() string {
// Get a trimmed address - useful for WS connections // Get a trimmed address - useful for WS connections
func (u parsedURL) GetTrimmedHostWithPath() string { func (u parsedURL) GetTrimmedHostWithPath() string {
// replace / with . for http requests (kvstore domain)
// if it's not an unix socket we return the normal URL
if !u.isUnixSocket {
return u.GetHostWithPath()
}
// if it's a unix socket we replace the host slashes with a period
// this is because otherwise the http.Client would think that the
// domain is invalid.
return strings.ReplaceAll(u.GetHostWithPath(), "/", ".") return strings.ReplaceAll(u.GetHostWithPath(), "/", ".")
} }
// GetDialAddress returns the endpoint to dial for the parsed URL
func (u parsedURL) GetDialAddress() string {
// if it's not a unix socket we return the host, example: localhost:443
if !u.isUnixSocket {
return u.Host
}
// otherwise we return the path of the unix socket, ex /tmp/socket
return u.GetHostWithPath()
}
// Get a trimmed address with protocol - useful as address in RPC connections // Get a trimmed address with protocol - useful as address in RPC connections
func (u parsedURL) GetTrimmedURL() string { func (u parsedURL) GetTrimmedURL() string {
return u.Scheme + "://" + u.GetTrimmedHostWithPath() return u.Scheme + "://" + u.GetTrimmedHostWithPath()
@ -350,7 +378,7 @@ func makeHTTPDialer(remoteAddr string) (func(string, string) (net.Conn, error),
} }
dialFn := func(proto, addr string) (net.Conn, error) { dialFn := func(proto, addr string) (net.Conn, error) {
return net.Dial(protocol, u.GetHostWithPath())
return net.Dial(protocol, u.GetDialAddress())
} }
return dialFn, nil return dialFn, nil


+ 50
- 0
rpc/jsonrpc/client/http_json_client_test.go View File

@ -34,3 +34,53 @@ func TestHTTPClientMakeHTTPDialer(t *testing.T) {
require.NotNil(t, addr) require.NotNil(t, addr)
} }
} }
func Test_parsedURL(t *testing.T) {
type test struct {
url string
expectedURL string
expectedHostWithPath string
expectedDialAddress string
}
tests := map[string]test{
"unix endpoint": {
url: "unix:///tmp/test",
expectedURL: "unix://.tmp.test",
expectedHostWithPath: "/tmp/test",
expectedDialAddress: "/tmp/test",
},
"http endpoint": {
url: "https://example.com",
expectedURL: "https://example.com",
expectedHostWithPath: "example.com",
expectedDialAddress: "example.com",
},
"http endpoint with port": {
url: "https://example.com:8080",
expectedURL: "https://example.com:8080",
expectedHostWithPath: "example.com:8080",
expectedDialAddress: "example.com:8080",
},
"http path routed endpoint": {
url: "https://example.com:8080/rpc",
expectedURL: "https://example.com:8080/rpc",
expectedHostWithPath: "example.com:8080/rpc",
expectedDialAddress: "example.com:8080",
},
}
for name, tt := range tests {
tt := tt // suppressing linter
t.Run(name, func(t *testing.T) {
parsed, err := newParsedURL(tt.url)
require.NoError(t, err)
require.Equal(t, tt.expectedDialAddress, parsed.GetDialAddress())
require.Equal(t, tt.expectedURL, parsed.GetTrimmedURL())
require.Equal(t, tt.expectedHostWithPath, parsed.GetHostWithPath())
})
}
}

Loading…
Cancel
Save