chore: rename AgentConn to WorkspaceAgentConn

The codersdk was becoming bloated with consts for the workspace agent that made no sense to a reader. `Tailnet*` is an example of these consts.
coder · kylecarbs · Jan 29, 2023 · Jan 29, 2023 · Jan 29, 2023 · Jan 29, 2023
commit 9747757ac00fb29d0d3d1b26e4132d80951f757e
diff --git a/agent/agent.go b/agent/agent.go
@@ -373,7 +373,7 @@ func (a *agent) trackConnGoroutine(fn func()) error {
 
 func (a *agent) createTailnet(ctx context.Context, derpMap *tailcfg.DERPMap) (_ *tailnet.Conn, err error) {
 	network, err := tailnet.NewConn(&tailnet.Options{
-		Addresses:          []netip.Prefix{netip.PrefixFrom(codersdk.TailnetIP, 128)},
+		Addresses:          []netip.Prefix{netip.PrefixFrom(codersdk.WorkspaceAgentIP, 128)},
 		DERPMap:            derpMap,
 		Logger:             a.logger.Named("tailnet"),
 		EnableTrafficStats: true,
@@ -387,7 +387,7 @@ func (a *agent) createTailnet(ctx context.Context, derpMap *tailcfg.DERPMap) (_
 		}
 	}()
 
-	sshListener, err := network.Listen("tcp", ":"+strconv.Itoa(codersdk.TailnetSSHPort))
+	sshListener, err := network.Listen("tcp", ":"+strconv.Itoa(codersdk.WorkspaceAgentSSHPort))
 	if err != nil {
 		return nil, xerrors.Errorf("listen on the ssh port: %w", err)
 	}
@@ -419,7 +419,7 @@ func (a *agent) createTailnet(ctx context.Context, derpMap *tailcfg.DERPMap) (_
 		return nil, err
 	}
 
-	reconnectingPTYListener, err := network.Listen("tcp", ":"+strconv.Itoa(codersdk.TailnetReconnectingPTYPort))
+	reconnectingPTYListener, err := network.Listen("tcp", ":"+strconv.Itoa(codersdk.WorkspaceAgentReconnectingPTYPort))
 	if err != nil {
 		return nil, xerrors.Errorf("listen for reconnecting pty: %w", err)
 	}
@@ -450,7 +450,7 @@ func (a *agent) createTailnet(ctx context.Context, derpMap *tailcfg.DERPMap) (_
 			if err != nil {
 				continue
 			}
-			var msg codersdk.ReconnectingPTYInit
+			var msg codersdk.WorkspaceAgentReconnectingPTYInit
 			err = json.Unmarshal(data, &msg)
 			if err != nil {
 				continue
@@ -463,7 +463,7 @@ func (a *agent) createTailnet(ctx context.Context, derpMap *tailcfg.DERPMap) (_
 		return nil, err
 	}
 
-	speedtestListener, err := network.Listen("tcp", ":"+strconv.Itoa(codersdk.TailnetSpeedtestPort))
+	speedtestListener, err := network.Listen("tcp", ":"+strconv.Itoa(codersdk.WorkspaceAgentSpeedtestPort))
 	if err != nil {
 		return nil, xerrors.Errorf("listen for speedtest: %w", err)
 	}
@@ -491,7 +491,7 @@ func (a *agent) createTailnet(ctx context.Context, derpMap *tailcfg.DERPMap) (_
 		return nil, err
 	}
 
-	statisticsListener, err := network.Listen("tcp", ":"+strconv.Itoa(codersdk.TailnetStatisticsPort))
+	statisticsListener, err := network.Listen("tcp", ":"+strconv.Itoa(codersdk.WorkspaceAgentStatisticsPort))
 	if err != nil {
 		return nil, xerrors.Errorf("listen for statistics: %w", err)
 	}
@@ -918,7 +918,7 @@ func (a *agent) handleSSHSession(session ssh.Session) (retErr error) {
 	return cmd.Wait()
 }
 
-func (a *agent) handleReconnectingPTY(ctx context.Context, logger slog.Logger, msg codersdk.ReconnectingPTYInit, conn net.Conn) (retErr error) {
+func (a *agent) handleReconnectingPTY(ctx context.Context, logger slog.Logger, msg codersdk.WorkspaceAgentReconnectingPTYInit, conn net.Conn) (retErr error) {
 	defer conn.Close()
 
 	connectionID := uuid.NewString()

diff --git a/agent/agent_test.go b/agent/agent_test.go
@@ -1077,7 +1077,7 @@ func (c closeFunc) Close() error {
 }
 
 func setupAgent(t *testing.T, metadata codersdk.WorkspaceAgentMetadata, ptyTimeout time.Duration) (
-	*codersdk.AgentConn,
+	*codersdk.WorkspaceAgentConn,
 	*client,
 	<-chan *codersdk.AgentStats,
 	afero.Fs,
@@ -1131,7 +1131,7 @@ func setupAgent(t *testing.T, metadata codersdk.WorkspaceAgentMetadata, ptyTimeo
 		return conn.UpdateNodes(node)
 	})
 	conn.SetNodeCallback(sendNode)
-	return &codersdk.AgentConn{
+	return &codersdk.WorkspaceAgentConn{
 		Conn: conn,
 	}, c, statsCh, fs
 }

diff --git a/agent/ports_supported.go b/agent/ports_supported.go
@@ -11,13 +11,13 @@ import (
 	"github.com/coder/coder/codersdk"
 )
 
-func (lp *listeningPortsHandler) getListeningPorts() ([]codersdk.ListeningPort, error) {
+func (lp *listeningPortsHandler) getListeningPorts() ([]codersdk.WorkspaceAgentListeningPort, error) {
 	lp.mut.Lock()
 	defer lp.mut.Unlock()
 
 	if time.Since(lp.mtime) < time.Second {
 		// copy
-		ports := make([]codersdk.ListeningPort, len(lp.ports))
+		ports := make([]codersdk.WorkspaceAgentListeningPort, len(lp.ports))
 		copy(ports, lp.ports)
 		return ports, nil
 	}
@@ -30,9 +30,9 @@ func (lp *listeningPortsHandler) getListeningPorts() ([]codersdk.ListeningPort,
 	}
 
 	seen := make(map[uint16]struct{}, len(tabs))
-	ports := []codersdk.ListeningPort{}
+	ports := []codersdk.WorkspaceAgentListeningPort{}
 	for _, tab := range tabs {
-		if tab.LocalAddr == nil || tab.LocalAddr.Port < codersdk.MinimumListeningPort {
+		if tab.LocalAddr == nil || tab.LocalAddr.Port < codersdk.WorkspaceAgentMinimumListeningPort {
 			continue
 		}
 
@@ -47,9 +47,9 @@ func (lp *listeningPortsHandler) getListeningPorts() ([]codersdk.ListeningPort,
 		if tab.Process != nil {
 			procName = tab.Process.Name
 		}
-		ports = append(ports, codersdk.ListeningPort{
+		ports = append(ports, codersdk.WorkspaceAgentListeningPort{
 			ProcessName: procName,
-			Network:     codersdk.ListeningPortNetworkTCP,
+			Network:     "tcp",
 			Port:        tab.LocalAddr.Port,
 		})
 	}
@@ -58,7 +58,7 @@ func (lp *listeningPortsHandler) getListeningPorts() ([]codersdk.ListeningPort,
 	lp.mtime = time.Now()
 
 	// copy
-	ports = make([]codersdk.ListeningPort, len(lp.ports))
+	ports = make([]codersdk.WorkspaceAgentListeningPort, len(lp.ports))
 	copy(ports, lp.ports)
 	return ports, nil
 }
diff --git a/agent/statsendpoint.go b/agent/statsendpoint.go
@@ -27,7 +27,7 @@ func (*agent) statisticsHandler() http.Handler {
 
 type listeningPortsHandler struct {
 	mut   sync.Mutex
-	ports []codersdk.ListeningPort
+	ports []codersdk.WorkspaceAgentListeningPort
 	mtime time.Time
 }
 
@@ -43,7 +43,7 @@ func (lp *listeningPortsHandler) handler(rw http.ResponseWriter, r *http.Request
 		return
 	}
 
-	httpapi.Write(r.Context(), rw, http.StatusOK, codersdk.ListeningPortsResponse{
+	httpapi.Write(r.Context(), rw, http.StatusOK, codersdk.WorkspaceAgentListeningPortsResponse{
 		Ports: ports,
 	})
 }
diff --git a/cli/portforward.go b/cli/portforward.go
@@ -156,7 +156,7 @@ func portForward() *cobra.Command {
 	return cmd
 }
 
-func listenAndPortForward(ctx context.Context, cmd *cobra.Command, conn *codersdk.AgentConn, wg *sync.WaitGroup, spec portForwardSpec) (net.Listener, error) {
+func listenAndPortForward(ctx context.Context, cmd *cobra.Command, conn *codersdk.WorkspaceAgentConn, wg *sync.WaitGroup, spec portForwardSpec) (net.Listener, error) {
 	_, _ = fmt.Fprintf(cmd.OutOrStderr(), "Forwarding '%v://%v' locally to '%v://%v' in the workspace\n", spec.listenNetwork, spec.listenAddress, spec.dialNetwork, spec.dialAddress)
 
 	var (

diff --git a/cli/root.go b/cli/root.go
@@ -5,6 +5,7 @@ import (
 	"flag"
 	"fmt"
 	"io"
+	"net"
 	"net/http"
 	"net/url"
 	"os"
@@ -590,7 +591,7 @@ func checkVersions(cmd *cobra.Command, client *codersdk.Client) error {
 	clientVersion := buildinfo.Version()
 	info, err := client.BuildInfo(ctx)
 	// Avoid printing errors that are connection-related.
-	if codersdk.IsConnectionErr(err) {
+	if isConnectionError(err) {
 		return nil
 	}
 
@@ -735,3 +736,16 @@ func dumpHandler(ctx context.Context) {
 		}
 	}
 }
+
+// IiConnectionErr is a convenience function for checking if the source of an
+// error is due to a 'connection refused', 'no such host', etc.
+func isConnectionError(err error) bool {
+	var (
+		// E.g. no such host
+		dnsErr *net.DNSError
+		// Eg. connection refused
+		opErr *net.OpError
+	)
+
+	return xerrors.As(err, &dnsErr) || xerrors.As(err, &opErr)
+}
diff --git a/cli/scaletest.go b/cli/scaletest.go
@@ -668,7 +668,7 @@ It is recommended that all rate limits are disabled on the server before running
 				if runCommand != "" {
 					config.ReconnectingPTY = &reconnectingpty.Config{
 						// AgentID is set by the test automatically.
-						Init: codersdk.ReconnectingPTYInit{
+						Init: codersdk.WorkspaceAgentReconnectingPTYInit{
 							ID:      uuid.Nil,
 							Height:  24,
 							Width:   80,

diff --git a/cli/vscodessh.go b/cli/vscodessh.go
@@ -184,7 +184,7 @@ type sshNetworkStats struct {
 	DownloadBytesSec int64              `json:"download_bytes_sec"`
 }
 
-func collectNetworkStats(ctx context.Context, agentConn *codersdk.AgentConn, lastCollected time.Time) (*sshNetworkStats, error) {
+func collectNetworkStats(ctx context.Context, agentConn *codersdk.WorkspaceAgentConn, lastCollected time.Time) (*sshNetworkStats, error) {
 	latency, p2p, err := agentConn.Ping(ctx)
 	if err != nil {
 		return nil, err

diff --git a/coderd/workspaceagents.go b/coderd/workspaceagents.go
@@ -382,15 +382,15 @@ func (api *API) workspaceAgentListeningPorts(rw http.ResponseWriter, r *http.Req
 
 	// Filter out ports that are globally blocked, in-use by applications, or
 	// common non-HTTP ports such as databases, FTP, SSH, etc.
-	filteredPorts := make([]codersdk.ListeningPort, 0, len(portsResponse.Ports))
+	filteredPorts := make([]codersdk.WorkspaceAgentListeningPort, 0, len(portsResponse.Ports))
 	for _, port := range portsResponse.Ports {
-		if port.Port < codersdk.MinimumListeningPort {
+		if port.Port < codersdk.WorkspaceAgentMinimumListeningPort {
 			continue
 		}
 		if _, ok := appPorts[port.Port]; ok {
 			continue
 		}
-		if _, ok := codersdk.IgnoredListeningPorts[port.Port]; ok {
+		if _, ok := codersdk.WorkspaceAgentIgnoredListeningPorts[port.Port]; ok {
 			continue
 		}
 		filteredPorts = append(filteredPorts, port)
@@ -400,7 +400,7 @@ func (api *API) workspaceAgentListeningPorts(rw http.ResponseWriter, r *http.Req
 	httpapi.Write(ctx, rw, http.StatusOK, portsResponse)
 }
 
-func (api *API) dialWorkspaceAgentTailnet(r *http.Request, agentID uuid.UUID) (*codersdk.AgentConn, error) {
+func (api *API) dialWorkspaceAgentTailnet(r *http.Request, agentID uuid.UUID) (*codersdk.WorkspaceAgentConn, error) {
 	clientConn, serverConn := net.Pipe()
 
 	derpMap := api.DERPMap.Clone()
@@ -467,7 +467,7 @@ func (api *API) dialWorkspaceAgentTailnet(r *http.Request, agentID uuid.UUID) (*
 			_ = conn.Close()
 		}
 	}()
-	return &codersdk.AgentConn{
+	return &codersdk.WorkspaceAgentConn{
 		Conn: conn,
 		CloseFunc: func() {
 			_ = clientConn.Close()

diff --git a/coderd/workspaceagents_test.go b/coderd/workspaceagents_test.go
@@ -517,10 +517,10 @@ func TestWorkspaceAgentListeningPorts(t *testing.T) {
 	}
 
 	willFilterPort := func(port int) bool {
-		if port < codersdk.MinimumListeningPort || port > 65535 {
+		if port < codersdk.WorkspaceAgentMinimumListeningPort || port > 65535 {
 			return true
 		}
-		if _, ok := codersdk.IgnoredListeningPorts[uint16(port)]; ok {
+		if _, ok := codersdk.WorkspaceAgentIgnoredListeningPorts[uint16(port)]; ok {
 			return true
 		}
 
@@ -560,7 +560,7 @@ func TestWorkspaceAgentListeningPorts(t *testing.T) {
 			port uint16
 		)
 		require.Eventually(t, func() bool {
-			for ignoredPort := range codersdk.IgnoredListeningPorts {
+			for ignoredPort := range codersdk.WorkspaceAgentIgnoredListeningPorts {
 				if ignoredPort < 1024 || ignoredPort == 5432 {
 					continue
 				}
@@ -615,7 +615,7 @@ func TestWorkspaceAgentListeningPorts(t *testing.T) {
 				}
 			)
 			for _, port := range res.Ports {
-				if port.Network == codersdk.ListeningPortNetworkTCP {
+				if port.Network == "tcp" {
 					if val, ok := expected[port.Port]; ok {
 						if val {
 							t.Fatalf("expected to find TCP port %d only once in response", port.Port)
@@ -637,7 +637,7 @@ func TestWorkspaceAgentListeningPorts(t *testing.T) {
 			require.NoError(t, err)
 
 			for _, port := range res.Ports {
-				if port.Network == codersdk.ListeningPortNetworkTCP && port.Port == lPort {
+				if port.Network == "tcp" && port.Port == lPort {
 					t.Fatalf("expected to not find TCP port %d in response", lPort)
 				}
 			}
@@ -667,7 +667,7 @@ func TestWorkspaceAgentListeningPorts(t *testing.T) {
 
 			sawCoderdPort := false
 			for _, port := range res.Ports {
-				if port.Network == codersdk.ListeningPortNetworkTCP {
+				if port.Network == "tcp" {
 					if port.Port == appLPort {
 						t.Fatalf("expected to not find TCP port (app port) %d in response", appLPort)
 					}

diff --git a/coderd/workspaceapps.go b/coderd/workspaceapps.go
@@ -862,9 +862,9 @@ func (api *API) proxyWorkspaceApplication(proxyApp proxyApplication, rw http.Res
 			return
 		}
 
-		if portInt < codersdk.MinimumListeningPort {
+		if portInt < codersdk.WorkspaceAgentMinimumListeningPort {
 			httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
-				Message: fmt.Sprintf("Application port %d is not permitted. Coder reserves ports less than %d for internal use.", portInt, codersdk.MinimumListeningPort),
+				Message: fmt.Sprintf("Application port %d is not permitted. Coder reserves ports less than %d for internal use.", portInt, codersdk.WorkspaceAgentMinimumListeningPort),
 			})
 			return
 		}

diff --git a/coderd/workspaceapps_test.go b/coderd/workspaceapps_test.go
@@ -858,7 +858,7 @@ func TestWorkspaceAppsProxySubdomain(t *testing.T) {
 		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
 		defer cancel()
 
-		port := uint16(codersdk.MinimumListeningPort - 1)
+		port := uint16(codersdk.WorkspaceAgentMinimumListeningPort - 1)
 		resp, err := requestWithRetries(ctx, t, client, http.MethodGet, proxyURL(t, client, port, "/", proxyTestAppQuery), nil)
 		require.NoError(t, err)
 		defer resp.Body.Close()

diff --git a/coderd/wsconncache/wsconncache.go b/coderd/wsconncache/wsconncache.go
@@ -32,11 +32,11 @@ func New(dialer Dialer, inactiveTimeout time.Duration) *Cache {
 }
 
 // Dialer creates a new agent connection by ID.
-type Dialer func(r *http.Request, id uuid.UUID) (*codersdk.AgentConn, error)
+type Dialer func(r *http.Request, id uuid.UUID) (*codersdk.WorkspaceAgentConn, error)
 
 // Conn wraps an agent connection with a reusable HTTP transport.
 type Conn struct {
-	*codersdk.AgentConn
+	*codersdk.WorkspaceAgentConn
 
 	locks         atomic.Uint64
 	timeoutMutex  sync.Mutex
@@ -49,8 +49,8 @@ func (c *Conn) HTTPTransport() *http.Transport {
 	return c.transport
 }
 
-// CloseWithError ends the HTTP transport if exists, and closes the agent.
-func (c *Conn) CloseWithError(err error) error {
+// Close ends the HTTP transport if exists, and closes the agent.
+func (c *Conn) Close() error {
 	if c.transport != nil {
 		c.transport.CloseIdleConnections()
 	}
@@ -59,7 +59,7 @@ func (c *Conn) CloseWithError(err error) error {
 	if c.timeout != nil {
 		c.timeout.Stop()
 	}
-	return c.AgentConn.CloseWithError(err)
+	return c.WorkspaceAgentConn.Close()
 }
 
 type Cache struct {
@@ -108,24 +108,20 @@ func (c *Cache) Acquire(r *http.Request, id uuid.UUID) (*Conn, func(), error) {
 			transport := defaultTransport.Clone()
 			transport.DialContext = agentConn.DialContext
 			conn := &Conn{
-				AgentConn:     agentConn,
-				timeoutCancel: timeoutCancelFunc,
-				transport:     transport,
+				WorkspaceAgentConn: agentConn,
+				timeoutCancel:      timeoutCancelFunc,
+				transport:          transport,
 			}
 			go func() {
 				defer c.closeGroup.Done()
-				var err error
 				select {
 				case <-timeoutCtx.Done():
-					err = xerrors.New("cache timeout")
 				case <-c.closed:
-					err = xerrors.New("cache closed")
 				case <-conn.Closed():
 				}
-
 				c.connMap.Delete(id.String())
 				c.connGroup.Forget(id.String())
-				_ = conn.CloseWithError(err)
+				_ = conn.Close()
 			}()
 			return conn, nil
 		})