[BUG] (v2.28.0) Fancy (ANSI) progress output not available

[leo9800]

Description

Docker compose commands, e.g. docker compose up -d, used to produce a fancy interactive output on terminals. But when compose is upgraded to v2.28.0, the fancy output disappears, left only a plain output.

A sample output (fancy, ANSI) of docker compose up -d from compose v2.27.3

A sample output (plain) of docker compose up -d from compose v2.28.0

Steps To Reproduce

1. install docker
2. install docker-compose
3. run docker compose up -d on any stack directory*

*: stack directory: a directory contains a docker compose stack, i.e. a docker-compose.yml file at least

Compose Version

Docker Compose version 2.28.0

Docker Environment

Client:
 Version:    26.1.4
 Context:    default
 Debug Mode: false
 Plugins:
  buildx: Docker Buildx (Docker Inc.)
    Version:  0.15.1
    Path:     /usr/lib/docker/cli-plugins/docker-buildx
  compose: Docker Compose (Docker Inc.)
    Version:  2.28.0
    Path:     /usr/lib/docker/cli-plugins/docker-compose

Server:
 Containers: 0
  Running: 0
  Paused: 0
  Stopped: 0
 Images: 0
 Server Version: 26.1.4
 Storage Driver: overlay2
  Backing Filesystem: extfs
  Supports d_type: true
  Using metacopy: true
  Native Overlay Diff: false
  userxattr: false
 Logging Driver: json-file
 Cgroup Driver: systemd
 Cgroup Version: 2
 Plugins:
  Volume: local
  Network: bridge host ipvlan macvlan null overlay
  Log: awslogs fluentd gcplogs gelf journald json-file local splunk syslog
 Swarm: inactive
 Runtimes: io.containerd.runc.v2 runc
 Default Runtime: runc
 Init Binary: docker-init
 containerd version: ae71819c4f5e67bb4d5ae76a6b735f29cc25774e.m
 runc version: 
 init version: de40ad0
 Security Options:
  seccomp
   Profile: builtin
  cgroupns
 Kernel Version: 6.9.5-zen1-1-zen
 Operating System: Arch Linux
 OSType: linux
 Architecture: x86_64
 CPUs: 8
 Total Memory: 15.18GiB
 Name: HOSTNAME_REDACTED
 ID: UUID_REDACTED
 Docker Root Dir: /var/lib/docker
 Debug Mode: false
 Experimental: false
 Insecure Registries:
  127.0.0.0/8
 Live Restore Enabled: false
 Default Address Pools:
   Base: 198.18.0.0/15, Size: 26

Anything else?

No response

[leo9800]

Dive Deeper

I tried to investigate into this issue and got some progress to share ...

---

I noticed a parameter in docker compose --help

      --progress string            Set type of progress output (auto, tty, plain,
                                   quiet) (default "auto")

I gave it a try by invoking docker compose --progress tty up -d on a stack directory, and the output below pops up:

$ ~/projects/compose/bin/build/docker-compose --progress tty up -d
WARN[0000] Terminal is not a POSIX console              
WARN[0000] Terminal is not a POSIX console              
 blss Pulling 
 ec99f8b99825 Already exists 
 69ed43a81650 Already exists 
 82333a17c7c2 Already exists 
 c6bc217d680f Already exists 
 4d17a28ca59a Already exists 
 281242b060e0 Already exists 
 19ec29a3be40 Already exists 
 290fd3d444de Already exists 
 166bdd0a726d Already exists 
 fb9c96a8445e Pulling fs layer 
 e3d4b9725e24 Pulling fs layer 
[OMITTED]

Note that the first 2 lines of warning message Terminal is not a POSIX console.

I therefore git grep 'Terminal is not a POSIX console' on this git repo and found that the error message comes from line 133 of pkg/progress/writer.go

compose/pkg/progress/writer.go

Lines 117 to 143 in 6a000dc

	// NewWriter returns a new multi-progress writer
	func NewWriter(ctx context.Context, out io.Writer, progressTitle string) (Writer, error) {
	_, isTerminal := term.GetFdInfo(out)
	dryRun, ok := ctx.Value(api.DryRunKey{}).(bool)
	if !ok {
	dryRun = false
	}
	if Mode == ModeQuiet {
	return quiet{}, nil
	}
	f, isConsole := out.(console.File) // see https://github.com/docker/compose/issues/10560
	if Mode == ModeAuto && isTerminal && isConsole {
	return newTTYWriter(f, dryRun, progressTitle)
	}
	if Mode == ModeTTY {
	if !isConsole {
	logrus.Warn("Terminal is not a POSIX console")
	} else {
	return newTTYWriter(f, dryRun, progressTitle)
	}
	}
	return &plainWriter{
	out: out,
	done: make(chan bool),
	dryRun: dryRun,
	}, nil
	}

It seems in the function NewWriter, parameter out is being used to determine if a TTYWriter could be used. (line 119, 127 and 128)

I then tried to identify the call stack of NewWriter() by language server and therefore find the variable passed into it as parameter out.

• NewWriter() called by RunWithStatus() on pkg/progress/writer.go:79, RunWithStatus() has an out parameter
• RunWithStatus() called by Run() on pkg/progress/writer.go:62 and RunWithTitle() on pkg/progress/writer.go:69, both of these functions has an out parameter
• Run() called by Up() on pkg/compose/up.go:39, which is related to command docker compose up -d, where the parameter out is feed by stdinfo() from a composeService instance.
• stdinfo() on pkg/compose/compose.go:136 returns dockerCli.Err(), unless an envvar COMPOSE_STATUS_STDOUT is set

compose/pkg/compose/compose.go

Lines 136 to 141 in 6a000dc

	func (s *composeService) stdinfo() io.Writer {
	if stdioToStdout {
	return s.dockerCli.Out()
	}
	return s.dockerCli.Err()
	}

While dockerCli.Err() is a function defined in docker/cli

https://github.com/docker/cli/blob/12ea47dafa7f36c324ff7e0b7dc4e23c7dd372aa/cli/command/cli.go#L43-L48

---

I also noticed that a recent commit (docker/cli@6b93cf2) modified the type of Stream.Err() from io.Writer to *streams.Out, this commit has been included in docker/cli v27.0.1rc1 and v27.0.1rc1 is included in docker/compose v2.28.0

go.mod from docker/compose v2.28.0

compose/go.mod

Line 16 in 6a000dc

github.com/docker/cli v27.0.1-rc.1+incompatible

go.mod from docker/compose v2.27.3 (version with expected behavior)

compose/go.mod

Line 18 in 77377f2

github.com/docker/docker v26.1.4+incompatible

[leo9800]

I am not sure if this issue should be posted in this repo or https://github.com/docker/cli

[glours]

Hello @leo9800
Thanks for catching this issue and for your deep dive investigation this is very useful 🙏
We'll take a look 👍

[sylvaindd]

New release fixed it for me, thank you

[leo9800]

Thanks @glours @vvoland

Confirm fixed. (v2.28.1)