Document why we have a loop retrying

josebalius · josebalius · commit b5a7a36ecedb · 2022-03-21T12:11:00.000-04:00
diff --git a/pkg/liveshare/port_forwarder_test.go b/pkg/liveshare/port_forwarder_test.go
@@ -82,6 +82,8 @@ func TestPortForwarderStart(t *testing.T) {
 
 	go func() {
 		var conn net.Conn
+
+		// We retry DialTimeout in a loop to deal with a race in PortForwarder startup.
 		for tries := 0; conn == nil && tries < 2; tries++ {
 			conn, err = net.DialTimeout("tcp", ":8000", 2*time.Second)
 			if conn == nil {
