Try Generics #19
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -65,7 +65,7 @@ func TestNewTCPStreamDialerIPv4(t *testing.T) { | |
| // Client | ||
| go func() { | ||
| defer running.Done() | ||
| dialer := &TCPDialer{} | ||
| dialer.Dialer.Control = func(network, address string, c syscall.RawConn) error { | ||
| require.Equal(t, "tcp4", network) | ||
| require.Equal(t, listener.Addr().String(), address) | ||
|
|
@@ -93,7 +93,7 @@ func TestNewTCPStreamDialerIPv4(t *testing.T) { | |
|
|
||
| func TestNewTCPStreamDialerAddress(t *testing.T) { | ||
| errCancel := errors.New("cancelled") | ||
| dialer := &TCPDialer{} | ||
|
|
||
| dialer.Dialer.Control = func(network, address string, c syscall.RawConn) error { | ||
| require.Equal(t, "tcp4", network) | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| // Copyright 2019 Jigsaw Operations LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // https://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package transport | ||
|
|
||
| import ( | ||
| "context" | ||
| ) | ||
|
|
||
| // Endpoint represents an endpoint that can be used to established connections to a fixed destination. | ||
| type Endpoint[Conn any] interface { | ||
| // Connect creates a connection bound to an endpoint, returning the connection. | ||
| Connect(ctx context.Context) (Conn, error) | ||
| } | ||
|
|
||
| // DialerEndpoint is an [Endpoint] that connects to the given address using the given [Dialer]. | ||
| // Useful if you talk repeatedly to an endpoint, such as a proxy or DNS resolver, or | ||
| // if you find yourself passing a (dialer, address) pair around. | ||
| func NewDialerEndpoint[C any](dialer Dialer[C], address string) Endpoint[C] { | ||
| return &dialerEndpoint[C]{dialer, address} | ||
| } | ||
|
|
||
| type dialerEndpoint[Conn any] struct { | ||
| Dialer Dialer[Conn] | ||
| Address string | ||
| } | ||
|
|
||
| var _ Endpoint[any] = (*dialerEndpoint[any])(nil) | ||
|
|
||
| // Connect implements [Endpoint].Connect. | ||
| func (e *dialerEndpoint[Conn]) Connect(ctx context.Context) (Conn, error) { | ||
| return e.Dialer.Dial(ctx, e.Address) | ||
| } | ||
|
|
||
| // Dialer provides a way to dial a destination and establish connections. | ||
| type Dialer[Conn any] interface { | ||
| // Dial connects to `raddr`. | ||
| // `raddr` has the form `host:port`, where `host` can be a domain name or IP address. | ||
| Dial(ctx context.Context, raddr string) (Conn, error) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -49,13 +49,13 @@ func (err *TestError) Unwrap() error { | |
| // TestResolverStreamConnectivity uses the given [transport.StreamEndpoint] to connect to a DNS resolver and resolve the test domain. | ||
| // The context can be used to set a timeout or deadline, or to pass values to the dialer. | ||
| func TestResolverStreamConnectivity(ctx context.Context, resolver transport.StreamEndpoint, testDomain string) (time.Duration, error) { | ||
| return testResolverConnectivity(ctx, resolver, testDomain) | ||
| } | ||
|
|
||
| // TestResolverPacketConnectivity uses the given [transport.PacketEndpoint] to connect to a DNS resolver and resolve the test domain. | ||
| // The context can be used to set a timeout or deadline, or to pass values to the listener. | ||
| func TestResolverPacketConnectivity(ctx context.Context, resolver transport.PacketEndpoint, testDomain string) (time.Duration, error) { | ||
| return testResolverConnectivity(ctx, resolver, testDomain) | ||
| } | ||
|
|
||
| func isTimeout(err error) bool { | ||
|
|
@@ -74,7 +74,11 @@ func makeTestError(op string, err error) error { | |
| return &TestError{Op: op, PosixError: code, Err: err} | ||
| } | ||
|
|
||
| // testResolverConnectivity uses the given [transport.Endpoint] to connect to a DNS resolver and resolve the test domain. | ||
| // If the connection returned by the endpoint is a [net.PacketConn], it sends the request as a DNS-over-UDP datagram, | ||
| // otherwise it sends the request as a DNS-over-TCP record. | ||
| // The [context.Context] can be used to set a timeout or deadline, or to pass values to the listener. | ||
| func testResolverConnectivity[Conn net.Conn](ctx context.Context, endpoint transport.Endpoint[Conn], testDomain string) (time.Duration, error) { | ||
| deadline, ok := ctx.Deadline() | ||
| if !ok { | ||
| // Default deadline is 5 seconds. | ||
|
|
@@ -86,7 +90,7 @@ func testResolver[C net.Conn](ctx context.Context, connect func(context.Context) | |
| } | ||
| testTime := time.Now() | ||
| testErr := func() error { | ||
| conn, dialErr := endpoint.Connect(ctx) | ||
| if dialErr != nil { | ||
| return makeTestError("dial", dialErr) | ||
| } | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,15 +3,14 @@ module github.com/Jigsaw-Code/outline-internal-sdk/x | |
| go 1.20 | ||
|
|
||
| require ( | ||
| github.com/Jigsaw-Code/outline-internal-sdk v0.0.0-20230523053248-546e6ee75a08 | ||
| github.com/miekg/dns v1.1.54 | ||
| github.com/stretchr/testify v1.8.2 | ||
| golang.org/x/sys v0.8.0 | ||
| ) | ||
|
|
||
| require ( | ||
| github.com/davecgh/go-spew v1.1.1 // indirect | ||
| github.com/pmezard/go-difflib v1.0.0 // indirect | ||
| github.com/shadowsocks/go-shadowsocks2 v0.1.5 // indirect | ||
| golang.org/x/crypto v0.9.0 // indirect | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,10 @@ | ||
| github.com/Jigsaw-Code/outline-internal-sdk v0.0.0-20230523053248-546e6ee75a08 h1:8WsJ5ZUk6GtfkLcNS6SHEzZzUEjVRxH19XXhwl5itbs= | ||
| github.com/Jigsaw-Code/outline-internal-sdk v0.0.0-20230523053248-546e6ee75a08/go.mod h1:R4RofyAAbIc8yzJgwxFDG4YE0pUku5p3iNfTc2BKGhQ= | ||
| github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= | ||
| github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= | ||
| github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= | ||
| github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI= | ||
| github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= | ||
| github.com/miekg/dns v1.1.54 h1:5jon9mWcb0sFJGpnI99tOMhCPyJ+RPVz5b63MQG0VWI= | ||
| github.com/miekg/dns v1.1.54/go.mod h1:uInx36IzPl7FYnDcMeVWxj9byh7DutNykX4G9Sj60FY= | ||
| github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -36,19 +36,23 @@ var debugLog log.Logger = *log.New(io.Discard, "", 0) | |
|
|
||
| // var errorLog log.Logger = *log.New(os.Stderr, "[ERROR] ", log.LstdFlags|log.Lmicroseconds|log.Lshortfile) | ||
|
|
||
| func newStreamDialer(proxyAddress string, cryptoKey *shadowsocks.EncryptionKey, prefix []byte) (transport.StreamDialer, error) { | ||
| dialer, err := shadowsocks.NewStreamDialer(&transport.TCPEndpoint{Address: proxyAddress}, cryptoKey) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| if len(prefix) > 0 { | ||
| dialer.SaltGenerator = shadowsocks.NewPrefixSaltGenerator(prefix) | ||
| } | ||
| return dialer, nil | ||
| } | ||
|
|
||
| func newPacketDialer(proxyAddress string, cryptoKey *shadowsocks.EncryptionKey) (transport.PacketDialer, error) { | ||
| listener, err := shadowsocks.NewPacketListener(&transport.UDPEndpoint{Address: proxyAddress}, cryptoKey) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return &transport.PacketListenerDialer{Listener: listener}, nil | ||
| } | ||
|
|
||
| type jsonRecord struct { | ||
|
|
@@ -149,19 +153,18 @@ func main() { | |
| var testDuration time.Duration | ||
| switch proto { | ||
| case "tcp": | ||
| dialer, err := newStreamDialer(proxyAddress, config.CryptoKey, config.Prefix) | ||
| if err != nil { | ||
| log.Fatalf("Failed to create StreamDialer: %v", err) | ||
| } | ||
| var resolver = transport.NewDialerEndpoint(dialer, resolverAddress) | ||
| testDuration, testErr = connectivity.TestResolverStreamConnectivity(context.Background(), resolver, *domainFlag) | ||
| case "udp": | ||
| dialer, err := newPacketDialer(proxyAddress, config.CryptoKey) | ||
| if err != nil { | ||
| log.Fatalf("Failed to create PacketListener: %v", err) | ||
| } | ||
| resolver := transport.NewDialerEndpoint(dialer, resolverAddress) | ||
| testDuration, testErr = connectivity.TestResolverPacketConnectivity(context.Background(), resolver, *domainFlag) | ||
| default: | ||
| log.Fatalf(`Invalid proto %v. Must be "tcp" or "udp"`, proto) | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wonder if I should define
That would be a parallel to
StreamConnand allow us to expand in the future, if needed.It would, however, be confusing with
net.PacketConn. Perhaps it makes sense to call itDatagramConnorDgramConn, to mirror posix sockets.