fix(agent/agentcontainers): fix incorrectly parsed port

johnstcn · johnstcn · commit 5189101f5b66 · 2025-03-11T21:02:35.000Z
diff --git a/agent/agentcontainers/containers_dockercli.go b/agent/agentcontainers/containers_dockercli.go
@@ -319,22 +319,23 @@ func runDockerInspect(ctx context.Context, execer agentexec.Execer, ids ...strin
 // To avoid a direct dependency on the Docker API, we use the docker CLI
 // to fetch information about containers.
 type dockerInspect struct {
-	ID         string                  `json:"Id"`
-	Created    time.Time               `json:"Created"`
-	Config     dockerInspectConfig     `json:"Config"`
-	HostConfig dockerInspectHostConfig `json:"HostConfig"`
-	Name       string                  `json:"Name"`
-	Mounts     []dockerInspectMount    `json:"Mounts"`
-	State      dockerInspectState      `json:"State"`
+	ID              string                       `json:"Id"`
+	Created         time.Time                    `json:"Created"`
+	Config          dockerInspectConfig          `json:"Config"`
+	Name            string                       `json:"Name"`
+	Mounts          []dockerInspectMount         `json:"Mounts"`
+	State           dockerInspectState           `json:"State"`
+	NetworkSettings dockerInspectNetworkSettings `json:"NetworkSettings"`
 }
 
 type dockerInspectConfig struct {
 	Image  string            `json:"Image"`
 	Labels map[string]string `json:"Labels"`
 }
 
-type dockerInspectHostConfig struct {
-	PortBindings map[string]any `json:"PortBindings"`
+type dockerInspectPort struct {
+	HostIP   string `json:"HostIp"`
+	HostPort string `json:"HostPort"`
 }
 
 type dockerInspectMount struct {
@@ -349,6 +350,10 @@ type dockerInspectState struct {
 	Error    string `json:"Error"`
 }
 
+type dockerInspectNetworkSettings struct {
+	Ports map[string][]dockerInspectPort `json:"Ports"`
+}
+
 func (dis dockerInspectState) String() string {
 	if dis.Running {
 		return "running"
@@ -388,20 +393,41 @@ func convertDockerInspect(raw string) ([]codersdk.WorkspaceAgentDevcontainer, []
 			Volumes:      make(map[string]string, len(in.Mounts)),
 		}
 
-		if in.HostConfig.PortBindings == nil {
-			in.HostConfig.PortBindings = make(map[string]any)
+		if in.NetworkSettings.Ports == nil {
+			in.NetworkSettings.Ports = make(map[string][]dockerInspectPort)
 		}
-		portKeys := maps.Keys(in.HostConfig.PortBindings)
+		portKeys := maps.Keys(in.NetworkSettings.Ports)
 		// Sort the ports for deterministic output.
 		sort.Strings(portKeys)
-		for _, p := range portKeys {
-			if port, network, err := convertDockerPort(p); err != nil {
-				warns = append(warns, err.Error())
-			} else {
+		// Each port binding may have multiple entries mapped to the same interface.
+		// Keep track of the ports we've already seen.
+		seen := make(map[int]struct{}, len(in.NetworkSettings.Ports))
+		for _, pk := range portKeys {
+			for _, p := range in.NetworkSettings.Ports[pk] {
+				_, network, err := convertDockerPort(pk)
+				if err != nil {
+					warns = append(warns, fmt.Sprintf("convert docker port: %s", err.Error()))
+					// Default network to "tcp" if we can't parse it.
+					network = "tcp"
+				}
+				hp, err := strconv.Atoi(p.HostPort)
+				if err != nil {
+					warns = append(warns, fmt.Sprintf("convert docker port: %s", err.Error()))
+					continue
+				}
+				if hp > 65535 || hp < 0 { // invalid port
+					warns = append(warns, fmt.Sprintf("convert docker port: invalid host port %d", hp))
+					continue
+				}
+				if _, ok := seen[hp]; ok {
+					// We've already seen this port, so skip it.
+					continue
+				}
 				out.Ports = append(out.Ports, codersdk.WorkspaceAgentListeningPort{
 					Network: network,
-					Port:    port,
+					Port:    uint16(hp),
 				})
+				seen[hp] = struct{}{}
 			}
 		}
 
diff --git a/agent/agentcontainers/containers_internal_test.go b/agent/agentcontainers/containers_internal_test.go
@@ -357,7 +357,7 @@ func TestConvertDockerPort(t *testing.T) {
 			expectError: "invalid port",
 		},
 	} {
-		tc := tc // not needed anymore but makes the linter happy
+		//nolint: paralleltest // variable recapture no longer required
 		t.Run(tc.name, func(t *testing.T) {
 			t.Parallel()
 			actualPort, actualNetwork, actualErr := convertDockerPort(tc.in)
@@ -511,7 +511,7 @@ func TestConvertDockerInspect(t *testing.T) {
 					Ports: []codersdk.WorkspaceAgentListeningPort{
 						{
 							Network: "tcp",
-							Port:    23456,
+							Port:    12345,
 						},
 					},
 					Volumes: map[string]string{},
@@ -548,10 +548,10 @@ func TestConvertDockerInspect(t *testing.T) {
 						"devcontainer.config_file": "/home/coder/src/coder/coder/agent/agentcontainers/testdata/devcontainer_simple.json",
 						"devcontainer.metadata":    "[]",
 					},
-					Running:      true,
-					Status:       "running",
-					Ports:        []codersdk.WorkspaceAgentListeningPort{},
-					Volumes:      map[string]string{},
+					Running: true,
+					Status:  "running",
+					Ports:   []codersdk.WorkspaceAgentListeningPort{},
+					Volumes: map[string]string{},
 				},
 			},
 		},
@@ -567,10 +567,10 @@ func TestConvertDockerInspect(t *testing.T) {
 						"devcontainer.config_file": "/home/coder/src/coder/coder/agent/agentcontainers/testdata/devcontainer_forwardport.json",
 						"devcontainer.metadata":    "[]",
 					},
-					Running:      true,
-					Status:       "running",
-					Ports:        []codersdk.WorkspaceAgentListeningPort{},
-					Volumes:      map[string]string{},
+					Running: true,
+					Status:  "running",
+					Ports:   []codersdk.WorkspaceAgentListeningPort{},
+					Volumes: map[string]string{},
 				},
 			},
 		},
@@ -586,12 +586,13 @@ func TestConvertDockerInspect(t *testing.T) {
 						"devcontainer.config_file": "/home/coder/src/coder/coder/agent/agentcontainers/testdata/devcontainer_appport.json",
 						"devcontainer.metadata":    "[]",
 					},
-					Running:      true,
-					Status:       "running",
+					Running: true,
+					Status:  "running",
 					Ports: []codersdk.WorkspaceAgentListeningPort{
 						{
 							Network: "tcp",
-							Port:    8080,
+							// Container port 8080 is mapped to 32768 on the host.
+							Port: 32768,
 						},
 					},
 					Volumes: map[string]string{},
