fix(agent/agentcontainers): stop logging empty lines (#18605)

DanielleMaywood · web-flow · commit 98c77fece529 · 2025-06-26T15:58:10.000Z
This PR makes the devcontainer logs have fewer whitespace lines.
diff --git a/agent/agentcontainers/api.go b/agent/agentcontainers/api.go
@@ -1442,7 +1442,7 @@ func (api *API) maybeInjectSubAgentIntoContainerLocked(ctx context.Context, dc c
 		return xerrors.Errorf("set agent binary executable: %w", err)
 	}
 
-	// Make sure the agent binary is executable so we can run it.
+	// Make sure the agent binary is owned by a valid user so we can run it.
 	if _, err := api.ccli.ExecAs(ctx, container.ID, "root", "/bin/sh", "-c", fmt.Sprintf("chown $(id -u):$(id -g) %s", coderPathInsideContainer)); err != nil {
 		return xerrors.Errorf("set agent binary ownership: %w", err)
 	}
diff --git a/agent/agentcontainers/devcontainercli.go b/agent/agentcontainers/devcontainercli.go
@@ -458,7 +458,7 @@ func (l *devcontainerCLILogWriter) Write(p []byte) (n int, err error) {
 		}
 		if logLine.Level >= 3 {
 			l.logger.Info(l.ctx, "@devcontainer/cli", slog.F("line", string(line)))
-			_, _ = l.writer.Write([]byte(logLine.Text + "\n"))
+			_, _ = l.writer.Write([]byte(strings.TrimSpace(logLine.Text) + "\n"))
 			continue
 		}
 		// If we've successfully parsed the final log line, it will successfully parse
diff --git a/agent/agentcontainers/devcontainercli_test.go b/agent/agentcontainers/devcontainercli_test.go
@@ -11,6 +11,7 @@ import (
 	"os"
 	"os/exec"
 	"path/filepath"
+	"runtime"
 	"strings"
 	"testing"
 
@@ -343,6 +344,10 @@ func TestDevcontainerCLI_WithOutput(t *testing.T) {
 	t.Run("Up", func(t *testing.T) {
 		t.Parallel()
 
+		if runtime.GOOS == "windows" {
+			t.Skip("Windows uses CRLF line endings, golden file is LF")
+		}
+
 		// Buffers to capture stdout and stderr.
 		outBuf := &bytes.Buffer{}
 		errBuf := &bytes.Buffer{}
diff --git a/agent/agentcontainers/testdata/devcontainercli/parse/up.golden b/agent/agentcontainers/testdata/devcontainercli/parse/up.golden
@@ -6,20 +6,14 @@ Run: docker buildx build --load --build-context dev_containers_feature_content_s
 #0 building with "orbstack" instance using docker driver
 
 #1 [internal] load build definition from Dockerfile.extended
-
 #1 transferring dockerfile: 3.09kB done
 #1 DONE 0.0s
 
 #2 resolve image config for docker-image://docker.io/docker/dockerfile:1.4
-
 #2 DONE 1.3s
-
-
 #3 docker-image://docker.io/docker/dockerfile:1.4@sha256:9ba7531bd80fb0a858632727cf7a112fbfd19b17e94c4e84ced81e24ef1a0dbc
 #3 CACHED
 
-
-
 #4 [internal] load .dockerignore
 #4 transferring context: 2B done
 #4 DONE 0.0s
@@ -61,17 +55,10 @@ Run: docker buildx build --load --build-context dev_containers_feature_content_s
 #15 writing image sha256:275dc193c905d448ef3945e3fc86220cc315fe0cb41013988d6ff9f8d6ef2357 done
 #15 naming to docker.io/library/vsc-devcontainers-template-starter-81d8f17e32abef6d434cbb5a37fe05e5c8a6f8ccede47a61197f002dcbf60566-features done
 #15 DONE 0.0s
-
 Run: docker buildx build --load --build-context dev_containers_feature_content_source=/var/folders/1y/cm8mblxd7_x9cljwl_jvfprh0000gn/T/devcontainercli/container-features/0.75.0-1744102171193 --build-arg _DEV_CONTAINERS_BASE_IMAGE=mcr.microsoft.com/devcontainers/javascript-node:1-18-bullseye --build-arg _DEV_CONTAINERS_IMAGE_USER=root --build-arg _DEV_CONTAINERS_FEATURE_CONTENT_SOURCE=dev_container_feature_content_temp --target dev_containers_target_stage -f /var/folders/1y/cm8mblxd7_x9cljwl_jvfprh0000gn/T/devcontainercli/container-features/0.75.0-1744102171193/Dockerfile.extended -t vsc-devcontainers-template-starter-81d8f17e32abef6d434cbb5a37fe05e5c8a6f8ccede47a61197f002dcbf60566-features /var/folders/1y/cm8mblxd7_x9cljwl_jvfprh0000gn/T/devcontainercli/empty-folder
 Run: docker run --sig-proxy=false -a STDOUT -a STDERR --mount type=bind,source=/code/devcontainers-template-starter,target=/workspaces/devcontainers-template-starter,consistency=cached --mount type=volume,src=dind-var-lib-docker-0pctifo8bbg3pd06g3j5s9ae8j7lp5qfcd67m25kuahurel7v7jm,dst=/var/lib/docker -l devcontainer.local_folder=/code/devcontainers-template-starter -l devcontainer.config_file=/code/devcontainers-template-starter/.devcontainer/devcontainer.json --privileged --entrypoint /bin/sh vsc-devcontainers-template-starter-81d8f17e32abef6d434cbb5a37fe05e5c8a6f8ccede47a61197f002dcbf60566-features -c echo Container started
 Container started
-
 Not setting dockerd DNS manually.
-
-[1mRunning the postCreateCommand from devcontainer.json...[0m
-
-
-
+[1mRunning the postCreateCommand from devcontainer.json...[0m
 added 1 package in 784ms
-
 {"outcome":"success","containerId":"bc72db8d0c4c4e941bd9ffc341aee64a18d3397fd45b87cd93d4746150967ba8","remoteUser":"node","remoteWorkspaceFolder":"/workspaces/devcontainers-template-starter"}

Original file line number	Diff line number	Diff line change
`@@ -1442,7 +1442,7 @@ func (api *API) maybeInjectSubAgentIntoContainerLocked(ctx context.Context, dc c`
`1442`	`1442`	`return xerrors.Errorf("set agent binary executable: %w", err)`
`1443`	`1443`	`}`
`1444`	`1444`
`1445`		`- // Make sure the agent binary is executable so we can run it.`
	`1445`	`+ // Make sure the agent binary is owned by a valid user so we can run it.`
`1446`	`1446`	`if _, err := api.ccli.ExecAs(ctx, container.ID, "root", "/bin/sh", "-c", fmt.Sprintf("chown $(id -u):$(id -g) %s", coderPathInsideContainer)); err != nil {`
`1447`	`1447`	`return xerrors.Errorf("set agent binary ownership: %w", err)`
`1448`	`1448`	`}`
Original file line number	Diff line number	Diff line change
`@@ -458,7 +458,7 @@ func (l *devcontainerCLILogWriter) Write(p []byte) (n int, err error) {`
`458`	`458`	`}`
`459`	`459`	`if logLine.Level >= 3 {`
`460`	`460`	`l.logger.Info(l.ctx, "@devcontainer/cli", slog.F("line", string(line)))`
`461`		`- _, _ = l.writer.Write([]byte(logLine.Text + "\n"))`
	`461`	`+ _, _ = l.writer.Write([]byte(strings.TrimSpace(logLine.Text) + "\n"))`
`462`	`462`	`continue`
`463`	`463`	`}`
`464`	`464`	`// If we've successfully parsed the final log line, it will successfully parse`