From b5a7a36ecedb9a92ebd629e14c2969349f99cfbd Mon Sep 17 00:00:00 2001
From: Jose Garcia <jose.balius@gmail.com>
Date: Mon, 21 Mar 2022 12:11:00 -0400
Subject: [PATCH] Document why we have a loop retrying

---
 pkg/liveshare/port_forwarder_test.go | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/pkg/liveshare/port_forwarder_test.go b/pkg/liveshare/port_forwarder_test.go
index 990a14e36..93f8187d8 100644
--- 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 {