fix: Close Ping DataChannel when connection ends (#382)

kylecarbs · web-flow · commit a8443d00b29e · 2021-07-13T21:58:26.000-05:00
Previously, Ping() would hang forever due to the DataChannel
never closing when the RTC connection ended.
diff --git a/wsnet/dial.go b/wsnet/dial.go
@@ -86,7 +86,7 @@ func Dial(conn net.Conn, iceServers []webrtc.ICEServer) (*Dialer, error) {
 		ctrl:        ctrl,
 		rtc:         rtc,
 		closedChan:  make(chan struct{}),
-		connClosers: make([]io.Closer, 0),
+		connClosers: []io.Closer{ctrl},
 	}
 
 	return dialer, dialer.negotiate()
diff --git a/wsnet/dial_test.go b/wsnet/dial_test.go
@@ -50,6 +50,8 @@ func ExampleDial_basic() {
 // nolint:gocognit,gocyclo
 func TestDial(t *testing.T) {
 	t.Run("Ping", func(t *testing.T) {
+		t.Parallel()
+
 		connectAddr, listenAddr := createDumbBroker(t)
 		_, err := Listen(context.Background(), listenAddr)
 		if err != nil {
@@ -67,7 +69,38 @@ func TestDial(t *testing.T) {
 		}
 	})
 
+	t.Run("Ping Close", func(t *testing.T) {
+		t.Parallel()
+
+		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
+		}
+		_ = dialer.Ping(context.Background())
+		closeTurn()
+		err = dialer.Ping(context.Background())
+		if err != io.EOF {
+			t.Error(err)
+			return
+		}
+	})
+
 	t.Run("OPError", func(t *testing.T) {
+		t.Parallel()
+
 		connectAddr, listenAddr := createDumbBroker(t)
 		_, err := Listen(context.Background(), listenAddr)
 		if err != nil {
@@ -91,6 +124,8 @@ func TestDial(t *testing.T) {
 	})
 
 	t.Run("Proxy", func(t *testing.T) {
+		t.Parallel()
+
 		listener, err := net.Listen("tcp", "0.0.0.0:0")
 		if err != nil {
 			t.Error(err)
@@ -134,6 +169,8 @@ func TestDial(t *testing.T) {
 
 	// Expect that we'd get an EOF on the server closing.
 	t.Run("EOF on Close", func(t *testing.T) {
+		t.Parallel()
+
 		listener, err := net.Listen("tcp", "0.0.0.0:0")
 		if err != nil {
 			t.Error(err)
@@ -167,6 +204,8 @@ func TestDial(t *testing.T) {
 	})
 
 	t.Run("Disconnect", func(t *testing.T) {
+		t.Parallel()
+
 		connectAddr, listenAddr := createDumbBroker(t)
 		_, err := Listen(context.Background(), listenAddr)
 		if err != nil {
@@ -190,6 +229,8 @@ func TestDial(t *testing.T) {
 	})
 
 	t.Run("Disconnect DialContext", func(t *testing.T) {
+		t.Parallel()
+
 		tcpListener, err := net.Listen("tcp", "0.0.0.0:0")
 		if err != nil {
 			t.Error(err)
@@ -232,6 +273,8 @@ func TestDial(t *testing.T) {
 	})
 
 	t.Run("Closed", func(t *testing.T) {
+		t.Parallel()
+
 		connectAddr, listenAddr := createDumbBroker(t)
 		_, err := Listen(context.Background(), listenAddr)
 		if err != nil {
diff --git a/wsnet/rtc.go b/wsnet/rtc.go
@@ -159,7 +159,7 @@ func newPeerConnection(servers []webrtc.ICEServer) (*webrtc.PeerConnection, erro
 	se.SetNetworkTypes([]webrtc.NetworkType{webrtc.NetworkTypeUDP4})
 	se.SetSrflxAcceptanceMinWait(0)
 	se.DetachDataChannels()
-	se.SetICETimeouts(time.Second*5, time.Second*5, time.Second*2)
+	se.SetICETimeouts(time.Second*3, time.Second*3, time.Second*2)
 	lf := logging.NewDefaultLoggerFactory()
 	lf.DefaultLogLevel = logging.LogLevelDisabled
 	se.LoggerFactory = lf
@@ -252,6 +252,9 @@ func waitForDataChannelOpen(ctx context.Context, channel *webrtc.DataChannel) er
 	if channel.ReadyState() == webrtc.DataChannelStateOpen {
 		return nil
 	}
+	if channel.ReadyState() != webrtc.DataChannelStateConnecting {
+		return fmt.Errorf("channel closed")
+	}
 	ctx, cancelFunc := context.WithTimeout(ctx, time.Second*15)
 	defer cancelFunc()
 	channel.OnOpen(func() {

Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,7 @@ func Dial(conn net.Conn, iceServers []webrtc.ICEServer) (*Dialer, error) {`
`86`	`86`	`ctrl: ctrl,`
`87`	`87`	`rtc: rtc,`
`88`	`88`	`closedChan: make(chan struct{}),`
`89`		`- connClosers: make([]io.Closer, 0),`
	`89`	`+ connClosers: []io.Closer{ctrl},`
`90`	`90`	`}`
`91`	`91`
`92`	`92`	`return dialer, dialer.negotiate()`