Add comment clarifying channel buffer

kylecarbs · kylecarbs · commit a2a4da4f70ff · 2022-01-27T19:36:59.000Z
diff --git a/peer/conn.go b/peer/conn.go
@@ -62,15 +62,17 @@ func newWithClientOrServer(servers []webrtc.ICEServer, client bool, opts *ConnOp
 		return nil, xerrors.Errorf("create peer connection: %w", err)
 	}
 	conn := &Conn{
-		pingChannelID:                   1,
-		pingEchoChannelID:               2,
-		opts:                            opts,
-		rtc:                             rtc,
-		offerrer:                        client,
-		closed:                          make(chan struct{}),
-		dcOpenChannel:                   make(chan *webrtc.DataChannel),
-		dcDisconnectChannel:             make(chan struct{}),
-		dcFailedChannel:                 make(chan struct{}),
+		pingChannelID:       1,
+		pingEchoChannelID:   2,
+		opts:                opts,
+		rtc:                 rtc,
+		offerrer:            client,
+		closed:              make(chan struct{}),
+		dcOpenChannel:       make(chan *webrtc.DataChannel),
+		dcDisconnectChannel: make(chan struct{}),
+		dcFailedChannel:     make(chan struct{}),
+		// This channel needs to be bufferred otherwise slow consumers
+		// of this will cause a connection failure.
 		localCandidateChannel:           make(chan webrtc.ICECandidateInit, 16),
 		pendingRemoteCandidates:         make([]webrtc.ICECandidateInit, 0),
 		localSessionDescriptionChannel:  make(chan webrtc.SessionDescription),
diff --git a/peer/conn_test.go b/peer/conn_test.go
@@ -48,7 +48,9 @@ var (
 )
 
 func TestMain(m *testing.M) {
-	goleak.VerifyTestMain(m)
+	// pion/ice doesn't properly close immediately. The solution for this isn't yet known. See:
+	// https://github.com/pion/ice/pull/413
+	goleak.VerifyTestMain(m, goleak.IgnoreTopFunction("github.com/pion/ice/v2.(*Agent).startOnConnectionStateChangeRoutine.func1 "))
 }
 
 func TestConn(t *testing.T) {

Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,9 @@ var (`
`48`	`48`	`)`
`49`	`49`
`50`	`50`	`func TestMain(m *testing.M) {`
`51`		`- goleak.VerifyTestMain(m)`
	`51`	`+ // pion/ice doesn't properly close immediately. The solution for this isn't yet known. See:`
	`52`	`+ // https://github.com/pion/ice/pull/413`
	`53`	`+ goleak.VerifyTestMain(m, goleak.IgnoreTopFunction("github.com/pion/ice/v2.(*Agent).startOnConnectionStateChangeRoutine.func1 "))`
`52`	`54`	`}`
`53`	`55`
`54`	`56`	`func TestConn(t *testing.T) {`