Repository: microsoft/terminal (language: cpp)

Issue:
Original console buffer is not restored when closing a secondary one
### Windows Terminal version

1.22.240823002-preview

### Windows build number

10.0.19045

### Other Software

_No response_

### Steps to reproduce

Reduced test code (by lhecker): 
```cpp
#define WIN32_LEAN_AND_MEAN
#include <Windows.h>

int main() {
    const auto buffer = CreateConsoleScreenBuffer(GENERIC_READ | GENERIC_WRITE, 0, nullptr, CONSOLE_TEXTMODE_BUFFER, nullptr);
    SetConsoleActiveScreenBuffer(buffer);
    CloseHandle(buffer);
    return 0;
}
```

---

Run a program which creates and activates a new console screen buffer using `CreateConsoleScreenBuffer` and `SetConsoleActiveScreenBuffer`.

The following C program with argument value 0-4 does all combos:
```
// usage: *argv 0|1|2|3|4
// create+activate new screen buffer, print a message to it, sleep 1s, then before exit:
//   0: do nothing.
//   1: CloseHandle(newbuf).
//   2: SetConsoleActiveScreenBuffer(orig_con)
//   3: CloseHandle(newbuf), SetConsoleActiveScreenBuffer(orig_con)
//   4: SetConsoleActiveScreenBuffer(orig_con), CloseHandle(newbuf)
```

<details>
<summary>newbuf.c</summary>

```c
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <windows.h>


#define writecon(h, s) WriteConsole(h, (s), strlen(s), 0, 0)
#define ERR_EXIT(...) (fprintf(stderr, __VA_ARGS__), exit(1), 0)

// usage: *argv 0|1|2|3|4
// create+activate new screen buffer, print a message to it, sleep 1s, then before exit:
//   0: do nothing.
//   1: CloseHandle(newbuf).
//   2: SetConsoleActiveScreenBuffer(orig_con)
//   3: CloseHandle(newbuf), SetConsoleActiveScreenBuffer(orig_con)
//   4: SetConsoleActiveScreenBuffer(orig_con), CloseHandle(newbuf)

int main(int argc, char **argv)
{
	int mode = argc > 1 ? atoi(argv[1]) : 0;

	HANDLE hcon = GetStdHandle(STD_OUTPUT_HANDLE);
	if (hcon == INVALID_HANDLE_VALUE)
		ERR_EXIT("can't get stdout handle\n");

	if (!writecon(hcon, "orig screen buffer\n"))
		ERR_EXIT("can't write to stdout console\n");

	HANDLE hnewbuf = CreateConsoleScreenBuffer(
		GENERIC_WRITE, FILE_SHARE_WRITE,
		0, CONSOLE_TEXTMODE_BUFFER, 0);
	if (hnewbuf == INVALID_HANDLE_VALUE)
		ERR_EXIT("can't create new screen buf\n");

	if (!SetConsoleActiveScreenBuffer(hnewbuf))
		ERR_EXIT("can't activete new screen buf\n");

	if (!writecon(hnewbuf, "new screen buffer\n"))
		ERR_EXIT("can't write to new screen buf\n");

	Sleep(1000);

	// all combos of "close new buf" and "restore orig buff", + reverse order.
	//
	// expected result:
	// - all combos restore the original buf on exit (maybe implicitly)
	//
	// actual result:
	// - Working as expected in conhost.exe or OpenConsole.exe (including 1.22)
	//   or Windows Terminal (up to and including 1.21).
	//
	// - in Windows Terminal 1.22: only 2 and 4 work as expected
	//   ("restore orig buf" without or before "close new buf")
	//   - 0: no close and no manual restore: not restored.
	//   - 1: close only: not restored.
	//   - 3: close and restored manually: not restored.

	switch (mode) {
		case 0:
			break;

		case 1:
			CloseHandle(hnewbuf);
			break;

		case 2:
			if (!SetConsoleActiveScreenBuffer(hcon))
				ERR_EXIT("can't restore orig screen buf\n");
			break;

		case 3:
			CloseHandle(hnewbuf);
			if (!SetConsoleActiveScreenBuffer(hcon))
				ERR_EXIT("can't restore orig screen buf\n");
			break;

		case 4:  // like 3 but in reverse order
			if (!SetConsoleActiveScreenBuffer(hcon))
				ERR_EXIT("can't restore orig screen buf\n");
			CloseHandle(hnewbuf);
			break;
	}

	return 0;
}
```

</details>



### Expected Behavior

Original screen buffer is restored when the application exits (its content and original cursor position), regardless if the new screen buffer handle is closed or not, and regardless if the original screen buffer is re-activated before exit.

### Actual Behavior

No issue in conhost.exe or OpenConsole.exe (even of 1.22), or Windows terminal up to and including 1.21.

With Windows terminal 1.22 (preview):
- The original screen buffer is only restored if `SetConsoleActiveScreenBuffer(orig_con)` is invoked without or before `CloseHandle(h_newbuf)`.
- Specifically, it's not restored if:
  - Neither `CloseHandle` nor `SetConsoleActiveScreenBuffer(orig_con)` are used.
  - Only `CloseHandle` is used.
  - Both `CloseHandle` and `SetConsoleActiveScreenBuffer(orig_con)` are used in that order.


Discussion / hints:
> [zadjii-msft](https://github.com/zadjii-msft) added this to the [Terminal v1.23](https://github.com/microsoft/terminal/milestone/57) milestone

While it's not mine to decide, and personally I can wait for a build with this fixed, I'd think it would be nice to fix it in 1.22, because it's still relatively early and only one preview build was released of 1.22, and it does affect the default behavior of existing applications, such as `less.exe`, and I'm guessing possibly more editors and pagers.
The milestone for us just indicates in what period we're working on it. Now that 1.22 was released we're in the 1.23 development period and so on. We usually spend the beginning of each period for fixing bugs in the just released versions. That will also be the case for this issue.

In short, I'm going to fix this soon. 🙂
> Now that 1.22 was released

Was it?

Yesterday 1.21 had the first stable release: "Terminal 1.21 is finally stable!...". and 1.22 had the first preview build.

Doesn't that mean that 1.21 is now ready for most users, but that there's still work to bugfix before 1.22 becomes stable and ready for public consumption? I.e. that "stable" is for most users, and that "preview" is for early adopters which can test it and report issues which would hopefully get fixed before 1.22 is considered "Ready" and distributed to the larger public?

The store page says about "Windows Terminal Preview":
> This is the preview build of the Windows Terminal, which contains the latest features as they are developed.

I.e. that there's still work to be done before the preview version is considered "ready"?

> In short, I'm going to fix this soon. 🙂

That's nice, though my main concern was/is that there would be a "stable" version which is distributed to a large number of people which has this issue...

Or am I missing something with the "stable"/"preview" terminology and/or pipeline?
> which contains the latest features as they are developed

This could be rephrased to something like "contains the latest features that we think are ready, but may not be entirely stable yet" (though there's a philosophical question about whether any software is ever truly "stable", as pretty much all software contains bugs 😄).

Basically, both "Windows Terminal" (current version `1.21.x`) and "Windows Terminal Preview" (current version `1.22.x`) receive bugfixes, but new features are developed for the main branch. The Preview version can be used by anyone but is more likely to have issues, especially shortly after a release.
> Basically, both "Windows Terminal" (current version `1.21.x`) and "Windows Terminal Preview" (current version `1.22.x`) receive bugfixes, but new features are developed for the main branch. The Preview version can be used by anyone but is more likely to have issues, especially shortly after a release.

Yeah, that's what I thought too.

So do you consider "restore screen buffer correctly like it behaved in 1.21" a new feature?

To me that's more like a bugfix in 1.22. Is it not?

(that's not to say that it must be fixed in 1.22. I marely expressed hope that it could get fixed in 1.22 before it becomes stable).
Well, I would certainly consider it a bugfix (though I'm not part of the team), but I think the point is that the milestone just indicates that the fix will be *developed* on the branch for 1.23. It would then presumably be cherry-picked or backported to 1.22 assuming the fix isn't riskier than the impact of the bug.
> It would then presumably be cherry-picked or backported to 1.22 assuming the fix isn't riskier than the impact of the bug.

Right. That was my missing link. That makes sense to me. Thanks.
That's all correct.

* This regressed in 1.22
* 1.22 was released to preview this week
* Preview builds are "mostly ready but likely with more bugs than stable" (and is typically high enough quality to be a daily driver)
* This bug is in the 1.23 milestone (which just tracks _when_ we will work on it)
* This one is tagged up for servicing back to 1.22. 
  * The project board that shows servicing bugs isn't publicly visible, but we're also actively working on updating that to make it cleaner. So it doesn't really need to be public to see our WIP on that. 
I'm on 1.21 and I can't get the buffer to restore. Open windows from a previous session is set. Am I doing something wrong?
> Open windows from a previous session is set.

This issue is not about restoring the content from a previous session when opening a new terminal window.

It's about restoring the screen content after an application (like an editor, or pager) creates and works in a new screen buffer, and then exits.

@richardeid If you still have this issue, please open a discussion or open another issue. We'll then try to help you.
@lhecker I think I misunderstood what this was. I was expecting my console history to restore. Thank you for following up

Fix patch:
diff --git a/src/host/VtIo.cpp b/src/host/VtIo.cpp
index 026010b2f70..d64d142d210 100644
--- a/src/host/VtIo.cpp
+++ b/src/host/VtIo.cpp
@@ -6,6 +6,7 @@
 
 #include <til/unicode.h>
 
+#include "directio.h"
 #include "handle.h" // LockConsole
 #include "output.h" // CloseConsoleProcessState
 #include "../interactivity/inc/ServiceLocator.hpp"
@@ -790,3 +791,51 @@ void VtIo::Writer::WriteInfos(til::point target, std::span<const CHAR_INFO> info
         } while (--repeat);
     }
 }
+
+void VtIo::Writer::WriteScreenInfo(SCREEN_INFORMATION& newContext, til::size oldSize) const
+{
+    const auto area = static_cast<size_t>(oldSize.width * oldSize.height);
+
+    auto& main = newContext.GetMainBuffer();
+    auto& alt = newContext.GetActiveBuffer();
+    const auto hasAltBuffer = &alt != &main;
+
+    // TODO GH#5094: This could use xterm's XTWINOPS "\e[8;<height>;<width>t" escape sequence here.
+    if (oldSize != main.GetBufferSize().Dimensions())
+    {
+        THROW_IF_NTSTATUS_FAILED(main.ResizeTraditional(oldSize));
+        main.SetViewportSize(&oldSize);
+    }
+    if (hasAltBuffer && oldSize != alt.GetBufferSize().Dimensions())
+    {
+        THROW_IF_NTSTATUS_FAILED(alt.ResizeTraditional(oldSize));
+        alt.SetViewportSize(&oldSize);
+    }
+
+    const auto request = Viewport::FromDimensions({}, oldSize);
+    Viewport read;
+    til::small_vector<CHAR_INFO, 1024> infos;
+    infos.resize(area, CHAR_INFO{ L' ', FOREGROUND_BLUE | FOREGROUND_GREEN | FOREGROUND_RED });
+
+    const auto dumpScreenInfo = [&](SCREEN_INFORMATION& screenInfo) {
+        THROW_IF_FAILED(ReadConsoleOutputWImplHelper(screenInfo, infos, request, read));
+        for (til::CoordType i = 0; i < oldSize.height; i++)
+        {
+            WriteInfos({ 0, i }, { infos.begin() + i * oldSize.width, static_cast<size_t>(oldSize.width) });
+        }
+
+        WriteCUP(screenInfo.GetTextBuffer().GetCursor().GetPosition());
+        WriteAttributes(screenInfo.GetAttributes());
+        WriteDECTCEM(screenInfo.GetTextBuffer().GetCursor().IsVisible());
+        WriteDECAWM(WI_IsFlagSet(screenInfo.OutputMode, ENABLE_WRAP_AT_EOL_OUTPUT));
+    };
+
+    WriteASB(false);
+    dumpScreenInfo(main);
+
+    if (hasAltBuffer)
+    {
+        WriteASB(true);
+        dumpScreenInfo(alt);
+    }
+}
diff --git a/src/host/VtIo.hpp b/src/host/VtIo.hpp
index a5d13764261..4e9d250c4cf 100644
--- a/src/host/VtIo.hpp
+++ b/src/host/VtIo.hpp
@@ -44,6 +44,7 @@ namespace Microsoft::Console::VirtualTerminal
             void WriteWindowTitle(std::wstring_view title) const;
             void WriteAttributes(const TextAttribute& attributes) const;
             void WriteInfos(til::point target, std::span<const CHAR_INFO> infos) const;
+            void WriteScreenInfo(SCREEN_INFORMATION& newContext, til::size oldSize) const;
 
         private:
             VtIo* _io = nullptr;
diff --git a/src/host/getset.cpp b/src/host/getset.cpp
index cb3c80d7bbb..81701a9f874 100644
--- a/src/host/getset.cpp
+++ b/src/host/getset.cpp
@@ -487,49 +487,8 @@ void ApiRoutines::SetConsoleActiveScreenBufferImpl(SCREEN_INFORMATION& newContex
 
         if (auto writer = gci.GetVtWriter())
         {
-            const auto viewport = gci.GetActiveOutputBuffer().GetBufferSize();
-            const auto size = viewport.Dimensions();
-            const auto area = static_cast<size_t>(viewport.Width() * viewport.Height());
-
-            auto& main = newContext.GetMainBuffer();
-            auto& alt = newContext.GetActiveBuffer();
-            const auto hasAltBuffer = &alt != &main;
-
-            // TODO GH#5094: This could use xterm's XTWINOPS "\e[8;<height>;<width>t" escape sequence here.
-            THROW_IF_NTSTATUS_FAILED(main.ResizeTraditional(size));
-            main.SetViewportSize(&size);
-            if (hasAltBuffer)
-            {
-                THROW_IF_NTSTATUS_FAILED(alt.ResizeTraditional(size));
-                alt.SetViewportSize(&size);
-            }
-
-            Viewport read;
-            til::small_vector<CHAR_INFO, 1024> infos;
-            infos.resize(area, CHAR_INFO{ L' ', FOREGROUND_BLUE | FOREGROUND_GREEN | FOREGROUND_RED });
-
-            const auto dumpScreenInfo = [&](SCREEN_INFORMATION& screenInfo) {
-                THROW_IF_FAILED(ReadConsoleOutputWImpl(screenInfo, infos, viewport, read));
-                for (til::CoordType i = 0; i < size.height; i++)
-                {
-                    writer.WriteInfos({ 0, i }, { infos.begin() + i * size.width, static_cast<size_t>(size.width) });
-                }
-
-                writer.WriteCUP(screenInfo.GetTextBuffer().GetCursor().GetPosition());
-                writer.WriteAttributes(screenInfo.GetAttributes());
-                writer.WriteDECTCEM(screenInfo.GetTextBuffer().GetCursor().IsVisible());
-                writer.WriteDECAWM(WI_IsFlagSet(screenInfo.OutputMode, ENABLE_WRAP_AT_EOL_OUTPUT));
-            };
-
-            writer.WriteASB(false);
-            dumpScreenInfo(main);
-
-            if (hasAltBuffer)
-            {
-                writer.WriteASB(true);
-                dumpScreenInfo(alt);
-            }
-
+            const auto oldSize = gci.GetActiveOutputBuffer().GetBufferSize().Dimensions();
+            writer.WriteScreenInfo(newContext, oldSize);
             writer.Submit();
         }
 
diff --git a/src/server/ObjectHandle.cpp b/src/server/ObjectHandle.cpp
index 1fbf69976fc..64f2d51a4c5 100644
--- a/src/server/ObjectHandle.cpp
+++ b/src/server/ObjectHandle.cpp
@@ -273,7 +273,18 @@ INPUT_READ_HANDLE_DATA* ConsoleHandleData::GetClientInput() const
     LOG_IF_FAILED(pScreenInfo->FreeIoHandle(this));
     if (!pScreenInfo->HasAnyOpenHandles())
     {
+        auto& gci = Microsoft::Console::Interactivity::ServiceLocator::LocateGlobals().getConsoleInformation();
+        const auto oldSize = gci.GetActiveOutputBuffer().GetBufferSize().Dimensions();
+        auto writer = gci.GetVtWriter();
+
         SCREEN_INFORMATION::s_RemoveScreenBuffer(pScreenInfo);
+
+        if (writer && gci.HasActiveOutputBuffer())
+        {
+            auto& newContext = gci.GetActiveOutputBuffer();
+            writer.WriteScreenInfo(newContext, oldSize);
+            writer.Submit();
+        }
     }
 
     return S_OK;


Test patch: