Skip to content
This repository was archived by the owner on Aug 30, 2024. It is now read-only.

fix: Remove active connections when RTC connection is lost #379

Merged
merged 4 commits into from
Jul 8, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 28 additions & 8 deletions wsnet/dial.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (
"fmt"
"io"
"net"
"sync"
"time"

"github.com/pion/datachannel"
Expand Down Expand Up @@ -81,9 +82,10 @@ func Dial(conn net.Conn, iceServers []webrtc.ICEServer) (*Dialer, error) {
flushCandidates()

dialer := &Dialer{
conn: conn,
ctrl: ctrl,
rtc: rtc,
conn: conn,
ctrl: ctrl,
rtc: rtc,
connClosers: make([]io.Closer, 0),
}

return dialer, dialer.negotiate()
Expand All @@ -97,6 +99,9 @@ type Dialer struct {
ctrl *webrtc.DataChannel
ctrlrw datachannel.ReadWriteCloser
rtc *webrtc.PeerConnection

connClosers []io.Closer
connClosersMut sync.Mutex
}

func (d *Dialer) negotiate() (err error) {
Expand All @@ -111,16 +116,27 @@ func (d *Dialer) negotiate() (err error) {

go func() {
defer close(errCh)
defer func() {
_ = d.conn.Close()
}()
err := waitForConnectionOpen(context.Background(), d.rtc)
if err != nil {
_ = d.conn.Close()
errCh <- err
return
}
go func() {
// Closing this connection took 30ms+.
_ = d.conn.Close()
}()
d.rtc.OnConnectionStateChange(func(pcs webrtc.PeerConnectionState) {
if pcs == webrtc.PeerConnectionStateConnected {
return
}

// Close connections opened while the RTC was alive.
d.connClosersMut.Lock()
defer d.connClosersMut.Unlock()
for _, connCloser := range d.connClosers {
_ = connCloser.Close()
}
d.connClosers = make([]io.Closer, 0)
})
}()

for {
Expand Down Expand Up @@ -210,6 +226,10 @@ func (d *Dialer) DialContext(ctx context.Context, network, address string) (net.
if err != nil {
return nil, fmt.Errorf("create data channel: %w", err)
}
d.connClosersMut.Lock()
d.connClosers = append(d.connClosers, dc)
d.connClosersMut.Unlock()

err = waitForDataChannelOpen(ctx, dc)
if err != nil {
return nil, fmt.Errorf("wait for open: %w", err)
Expand Down
45 changes: 45 additions & 0 deletions wsnet/dial_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@ import (
"context"
"crypto/rand"
"errors"
"fmt"
"io"
"net"
"strconv"
"testing"

"github.com/pion/ice/v2"
"github.com/pion/webrtc/v3"
)

Expand Down Expand Up @@ -44,6 +46,7 @@ func ExampleDial_basic() {
// You now have access to the proxied remote port in `conn`.
}

// nolint:gocognit
func TestDial(t *testing.T) {
t.Run("Ping", func(t *testing.T) {
connectAddr, listenAddr := createDumbBroker(t)
Expand Down Expand Up @@ -184,6 +187,48 @@ func TestDial(t *testing.T) {
t.Error(err)
}
})

t.Run("Disconnect DialContext", func(t *testing.T) {
tcpListener, err := net.Listen("tcp", "0.0.0.0:0")
if err != nil {
t.Error(err)
return
}
go func() {
_, _ = tcpListener.Accept()
}()

connectAddr, listenAddr := createDumbBroker(t)
_, err = Listen(context.Background(), listenAddr)
if err != nil {
t.Error(err)
return
}
turnAddr, closeTurn := createTURNServer(t, ice.SchemeTypeTURN)
dialer, err := DialWebsocket(context.Background(), connectAddr, []webrtc.ICEServer{{
URLs: []string{fmt.Sprintf("turn:%s", turnAddr)},
Username: "example",
Credential: testPass,
CredentialType: webrtc.ICECredentialTypePassword,
}})
if err != nil {
t.Error(err)
return
}
conn, err := dialer.DialContext(context.Background(), "tcp", tcpListener.Addr().String())
if err != nil {
t.Error(err)
return
}
// Close the TURN server before reading...
// WebRTC connections take a few seconds to timeout.
closeTurn()
_, err = conn.Read(make([]byte, 16))
if err != io.EOF {
t.Error(err)
return
}
})
}

func BenchmarkThroughput(b *testing.B) {
Expand Down
10 changes: 9 additions & 1 deletion wsnet/rtc.go
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,8 @@ func newPeerConnection(servers []webrtc.ICEServer) (*webrtc.PeerConnection, erro
lf.DefaultLogLevel = logging.LogLevelDisabled
se.LoggerFactory = lf

transportPolicy := webrtc.ICETransportPolicyAll

// If one server is provided and we know it's TURN, we can set the
// relay acceptable so the connection starts immediately.
if len(servers) == 1 {
Expand All @@ -174,12 +176,18 @@ func newPeerConnection(servers []webrtc.ICEServer) (*webrtc.PeerConnection, erro
se.SetNetworkTypes([]webrtc.NetworkType{webrtc.NetworkTypeTCP4, webrtc.NetworkTypeTCP6})
se.SetRelayAcceptanceMinWait(0)
}
if err == nil && (url.Scheme == ice.SchemeTypeTURN || url.Scheme == ice.SchemeTypeTURNS) {
// Local peers will connect if they discover they live on the same host.
// For testing purposes, it's simpler if they cannot peer on the same host.
transportPolicy = webrtc.ICETransportPolicyRelay
}
}
}
api := webrtc.NewAPI(webrtc.WithSettingEngine(se))

return api.NewPeerConnection(webrtc.Configuration{
ICEServers: servers,
ICEServers: servers,
ICETransportPolicy: transportPolicy,
})
}

Expand Down
10 changes: 5 additions & 5 deletions wsnet/rtc_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ func TestDialICE(t *testing.T) {
t.Run("TURN with TLS", func(t *testing.T) {
t.Parallel()

addr := createTURNServer(t, ice.SchemeTypeTURNS, "test")
addr, _ := createTURNServer(t, ice.SchemeTypeTURNS)
err := DialICE(webrtc.ICEServer{
URLs: []string{fmt.Sprintf("turns:%s", addr)},
Username: "example",
Credential: "test",
Credential: testPass,
CredentialType: webrtc.ICECredentialTypePassword,
}, &DialICEOptions{
Timeout: time.Millisecond,
Expand All @@ -34,11 +34,11 @@ func TestDialICE(t *testing.T) {
t.Run("Protocol mismatch", func(t *testing.T) {
t.Parallel()

addr := createTURNServer(t, ice.SchemeTypeTURNS, "test")
addr, _ := createTURNServer(t, ice.SchemeTypeTURNS)
err := DialICE(webrtc.ICEServer{
URLs: []string{fmt.Sprintf("turn:%s", addr)},
Username: "example",
Credential: "test",
Credential: testPass,
CredentialType: webrtc.ICECredentialTypePassword,
}, &DialICEOptions{
Timeout: time.Millisecond,
Expand All @@ -52,7 +52,7 @@ func TestDialICE(t *testing.T) {
t.Run("Invalid auth", func(t *testing.T) {
t.Parallel()

addr := createTURNServer(t, ice.SchemeTypeTURNS, "test")
addr, _ := createTURNServer(t, ice.SchemeTypeTURNS)
err := DialICE(webrtc.ICEServer{
URLs: []string{fmt.Sprintf("turns:%s", addr)},
Username: "example",
Expand Down
16 changes: 11 additions & 5 deletions wsnet/wsnet_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,11 @@ import (
"nhooyr.io/websocket"
)

const (
// Password used connecting to the test TURN server.
testPass = "test"
)

// createDumbBroker proxies sockets between /listen and /connect
// to emulate an authenticated WebSocket pair.
func createDumbBroker(t testing.TB) (connectAddr string, listenAddr string) {
Expand Down Expand Up @@ -86,7 +91,7 @@ func createDumbBroker(t testing.TB) (connectAddr string, listenAddr string) {
}

// createTURNServer allocates a TURN server and returns the address.
func createTURNServer(t *testing.T, server ice.SchemeType, pass string) string {
func createTURNServer(t *testing.T, server ice.SchemeType) (string, func()) {
var (
listeners []turn.ListenerConfig
pcListeners []turn.PacketConnConfig
Expand Down Expand Up @@ -136,24 +141,25 @@ func createTURNServer(t *testing.T, server ice.SchemeType, pass string) string {
ListenerConfigs: listeners,
Realm: "coder",
AuthHandler: func(username, realm string, srcAddr net.Addr) (key []byte, ok bool) {
return turn.GenerateAuthKey(username, realm, pass), true
return turn.GenerateAuthKey(username, realm, testPass), true
},
LoggerFactory: lf,
})
if err != nil {
t.Error(err)
}
t.Cleanup(func() {
closeFunc := func() {
for _, l := range listeners {
l.Listener.Close()
}
for _, l := range pcListeners {
l.PacketConn.Close()
}
srv.Close()
})
}
t.Cleanup(closeFunc)

return listenAddr.String()
return listenAddr.String(), closeFunc
}

func generateTLSConfig(t testing.TB) *tls.Config {
Expand Down