Implement Console.SetWindowSize() for linux

[HJLeee]

Implement Console.SetWindowSize() using the same system call with ConsoleGetWindowSize() (ioctl w/ set param TIOCSWINSZ).

[dotnet-issue-labeler]

Note regarding the new-api-needs-documentation label:

This serves as a reminder for when your PR is modifying a ref *.cs file and adding/modifying public APIs, to please make sure the API implementation in the src *.cs file is documented with triple slash comments, so the PR reviewers can sign off that change.

[ghost]

Tagging subscribers to this area: @dotnet/area-system-console
See info in area-owners.md if you want to be subscribed.

Issue Details

---

Implement Console.SetWindowSize() using the same system call with ConsoleGetWindowSize() (ioctl w/ set param TIOCSWINSZ).

Author:	HJLeee
Assignees:	-
Labels:	area-System.Console, new-api-needs-documentation
Milestone:	-

[HJLeee]

@stephentoub Would you review this please?

[adamsitnik]

@HJLeee thank you for your contribution! PTAL at my comments.

[adamsitnik]

HI @HJLeee

Please excuse me for the delay in the review.

I've cloned your fork and tried to add some new console manual tests:

        [ConditionalFact(nameof(ManualTestsEnabled))]
        [SkipOnPlatform(TestPlatforms.Browser | TestPlatforms.iOS | TestPlatforms.MacCatalyst | TestPlatforms.tvOS, "Not supported on Browser, iOS, MacCatalyst, or tvOS.")]
        public static void ResizeTest()
        {
            bool wasResized = false;

            using (ManualResetEvent manualResetEvent = new(false))
            using (PosixSignalRegistration.Create(PosixSignal.SIGWINCH,
               ctx =>
               {
                   wasResized = true;
                   Assert.Equal(PosixSignal.SIGWINCH, ctx.Signal);
                   manualResetEvent.Set();
               }))
            {
                int widthBefore = Console.WindowWidth;
                int heightBefore = Console.WindowHeight;

                Assert.False(wasResized);

                Console.SetWindowSize(widthBefore / 2, heightBefore / 2);

                Assert.True(manualResetEvent.WaitOne(TimeSpan.FromMilliseconds(50)));
                Assert.True(wasResized);
                Assert.Equal(widthBefore / 2, Console.WindowWidth );
                Assert.Equal(heightBefore / 2, Console.WindowHeight );

                try
                {
                    AssertUserExpectedResults("terminal window getting two times smaller?");
                }
                finally
                {
                    Console.SetWindowSize(widthBefore, heightBefore);
                }
            }
        }

The problem is that the value is set correctly (and we get signal notification), but Terminal size does not change in visible way (I've tested GNOME and xterm terminals on Ubuntu). According to this StackOverflow answer it does not work by design on most of the terminals and we should use escape sequences to get it working. We are already using some:

runtime/src/libraries/System.Console/src/System/ConsolePal.Unix.cs

Lines 834 to 840 in 7fbf1c1

	private static void WriteResetColorString()
	{
	if (ConsoleUtils.EmitAnsiColorCodes)
	{
	WriteStdoutAnsiString(TerminalFormatStringsInstance.Reset);
	}
	}

Which Terminal have you used for testing?

To run any dotnet app using your local build of dotnet/runtime you need to find corerun:

find -name corerun

and run it by providing the path to the dll:

./artifacts/bin/testhost/net7.0-Linux-Release-x64/shared/Microsoft.NETCore.App/8.0.0/corerun $pathTo.dll

[HJLeee]

Hi, Thank you for the testcase and review.

Which Terminal have you used for testing?

I've used my ubuntu 22.04 with screen-256color TERM and checked effectiveness with nvim as below.
You can see nvim uses the value I set for testing.

· ~/dotnet/tests/winsize $ cat Program.cs
// See https://aka.ms/new-console-template for more information
Console.SetWindowSize(80,30);
Console.WriteLine("Width: {0}, Height: {1}", Console.WindowWidth, Console.WindowHeight);

[stephentoub]

LGTM. Thanks!

[adamsitnik]

LGTM, big thanks for your contribution @HJLeee !

[adamsitnik]

src/libraries/apicompat/ApiCompat.proj(50,5): error CP0014: (NETCORE_ENGINEERING_TELEMETRY=Build) Cannot remove attribute 'System.Runtime.Versioning.UnsupportedOSPlatformAttribute("android")' from 'System.Console.WindowHeight.get'.

@ViktorHofer we want to introduce this change on purpose, what is needed to make the CI green in such case?

[ViktorHofer]

Replied offline:

You will need to add the compatibility difference to the suppression file that is used when comparing net7.0 against net6.0: runtime/ApiCompatBaseline.NetCoreAppLatestStable.xml at main · dotnet/runtime (github.com).
You can either hand-edit it or use the following command to update it: dotnet.cmd src/libraries/apicompat --no-dependencies /p:GenerateCompatibilitySuppressionFile=true

[adamsitnik]

@ViktorHofer I've done that and pushed the changes. I can perform a full clean build now (build -c Release -subset clr+libs+libs.tests) on both Windows and Linux, but the CI is still failing with the old error message (before the fix I was getting the same error locally). Do you have any idea why?

[ViktorHofer]

@ViktorHofer I've done that and pushed the changes. I can perform a full clean build now (build -c Release -subset clr+libs+libs.tests) on both Windows and Linux, but the CI is still failing with the old error message (before the fix I was getting the same error locally). Do you have any idea why?

Looking now

[ViktorHofer]

The build is passing for me locally as well and I diffed the binlogs from the failing run and the local one. There aren't any differences that would explain this behavior.

After spending some time on it, I just noticed that CI wasn't triggered for your commit :(

[ViktorHofer]

/azp run dotnet-linker-tests

[ViktorHofer]

/azp run runtime-dev-innerloop

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[ViktorHofer]

/azp run runtime

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[ViktorHofer]

/azp run runtime-staging

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[HJLeee]

Wow. Thank you for APICompat and CI stuff. 😄