Broken output on Windows when using Windows Terminal

[michal-z]

Zig Version

0.11.0-dev.4195+7f3fdd2ff

Steps to Reproduce and Observed Behavior

Compiler output looks broken, it prints a message for every step.

git clone https://github.com/michal-z/zig-gamedev.git
cd zig-gamedev
zig build test
steps [4/32] zig test zmath-tests Debug native... Semantic Analysis [2053] ... ←[79D←[0Ksteps [4/32] zig test zmath-tests Debug native... LLVM Emit Object... ←[70D←[0Ksteps [4/32] zig test zjobs-tests Debug native... LLD Link... ←[62D←[0Ksteps [4/32] zig build-lib zphysics Debug native... ←[52D←[0Ksteps [4/32] zig build-lib zphysics Debug native... ←[52D←[0Ksteps [4/32] zig build-lib zphysics Debug native... ←[52D←[0Ksteps [14/32] zig test zflecs-tests Debug native... AST Lowering [388] io\tty.zig... ←[85D←[0Ksteps [14/32] zig test zglfw-tests Debug native... mingw-w64 msvcrt-os.lib... ←[78D←[0Ksteps [14/32] zig test zphysics-tests-f32 Debug native... mingw-w64 msvcrt-os.lib... ←[85D←[0Ksteps [14/32] zig test zphysics-tests-f32 Debug native... mingw-w64 mingwex.lib... ←[83D←[0Ksteps [14/32] zig test zphysics-tests-f32 Debug native... mingw-w64 mingwex.lib... ←[83D←[0Ksteps [14/32] zig test zaudio-tests Debug native... mingw-w64 uuid.lib... ←[74D←[0Ksteps [14/32] zig test zglfw-tests Debug native... Semantic Analysis [1781] ... ←[80D←[0Ksteps [14/32] zig test zstbi-tests Debug native... LLD Link... ←[63D←[0Ksteps [14/32] zig test zphysics-tests-f32 Debug native... libcxx... ←[68D←[0Ksteps [14/32] zig test zaudio-tests Debug native... LLVM Emit Object... ←[72D←[0Ksteps [14/32] zig test zglfw-tests Debug native... LLD Link... ←[63D←[0Ksteps [14/32] zig test zphysics-tests-f32 Debug native... Semantic Analysis [2791] ...
 ←[87D←[0Ksteps [14/32] zig test zphysics-tests-f32 Debug native... LLVM Emit Object... ←[78D←[0Ksteps [19/32] run zglfw-tests... ←[33D←[0Ksteps [21/32] run zflecs-tests [2/5] ←[37D←[0Ksteps [22/32] ←[14D←[0Ksteps [23/32] ←[14D←[0Ksteps [23/32] zig test zphysics-tests-f32 Debug native... LLVM Emit Object... ←[78D←[0Ksteps [23/32] zig test zphysics-tests-f32 Debug native... LLVM Emit Object... ←[78D←[0Ksteps [23/32] run zflecs-tests [5/5] ←[37D←[0Ksteps [23/32] run zaudio-tests [7/8] ←[37D←[0Ksteps [26/32] zig test zphysics-tests-f32 Debug native... LLD Link... ←[70D←[0Ksteps [26/32] zig test zphysics-tests-f32 Debug native... LLD Link... ←[70D←[0Ksteps [27/32] run zphysics-tests-f32 [1/16] ←[44D←[0Ksteps [27/32] run zphysics-tests-f32 [3/16] ←[44D←[0Ksteps [27/32] run zphysics-tests-f32 [6/16] ←[44D←[0Ksteps [27/32] run zphysics-tests-f32 [15/16] ←[45D←[0Ksteps [29/32] ←[14D←[0K

Expected Behavior

Output should look like on Linux.

[andrewrk]

Hmmm, is this a regression?

[michal-z]

Hmmm, is this a regression?

Yes, it started to be like this from 0.11.0-dev.3771.

[squeek502]

My guess is that this would be caused by #16080, but will double check. If so, it would mean that GetConsoleMode is returning with the ENABLE_VIRTUAL_TERMINAL_PROCESSING flag set to true, but it's failing to actually parse/render these ANSI escape codes correctly

I'm seeing the same thing locally, so I will look more into it.

[squeek502]

This is weird, but the escape codes seem to be parsed if I change the session's codepage to UTF-8 (maybe because the default code page of 437 has a glyph for \x1b, but color escape codes seem to work fine with code page 437... so it's still a mystery).

It's still buggy with the UTF-8 code page, though (the lines aren't cleared properly):

> chcp 65001
Active code page: 65001

> zig build test
steps [20/32] zig build-lib zphysics Debug native... Compile C Objects [70/132] C Csteps [20/32] zig build-lib zphysics Debug native... Compile C Objects [106/132] ]steps [20/32] zig build-lib zphysics Debug native... Compile C Objects [106/132 2steps [20/32] zig build-lib zphysics Debug native... Compile C Objects [106/132] ]steps [20/32] zig build-lib zphysics Debug native... Compile C Obj jsteps [20/32] zig build-lib zphysics Debug native... .steps [20/32] zig build-lib zphysics D Dsteps [20/32] zig build- -steps [20/ /steps [20/32] zig test zmesh-tests Debug native... Compile C Objects [19/19] cxa_demang... ssteps [20/32] zig test zmesh-tests Debug native... Compile C Objects [19/19] cxa_d dsteps [20/32] zig test zmesh-tests Debug native... Compile C Objects ssteps [20/32] zig test zmesh-tests Debug native... Com msteps [20/32] zig test zmesh-tests Debug gsteps [20/32] zig test zmesh-tests De esteps [20/32] zig build-lib zphysics Debug steps [29/32 2steps [29/32] zig gsteps [29/32] zig te esteps [30/32] run zphysics-tests-f32 [1/16] 4D

Some potential quick fixes until this is understood more fully:

• Revert windows: detect ANSI support in more terminals #16080, but this would have the side-effect of making colored output in test diagnostics from things like expectEqualSlices not show up when doing zig build
• Make Progress.zig always use the Windows Console APIs on Windows regardless of whether or not ANSI escape codes are detected as supported, since it seems like the escape codes used in the progress bar are ones that the Windows implementation struggles with

[squeek502]

This actually seems to be zig build test-specific. Taking the test code from std.Progress and running it in a standalone exe works fine on master.

EDIT: I can't seem to get a minimal reproduction outside of the zig-gamedev build.zig