Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clear Buffer is broken in Windows Terminal Preview (1.22.2362.0) #17867

Open
valiko-ua opened this issue Sep 5, 2024 · 3 comments · May be fixed by #17884
Open

Clear Buffer is broken in Windows Terminal Preview (1.22.2362.0) #17867

valiko-ua opened this issue Sep 5, 2024 · 3 comments · May be fixed by #17884
Labels
A11ySev1 Accessibility tracking A11yWCAG Accessibility tracking Area-Accessibility Issues related to accessibility HCL-E+D Accessibility tracking HCL-WindowsTerminal Accessibility tracking In-PR This issue has a related PR Issue-Bug It either shouldn't be doing this or needs an investigation. Needs-Tag-Fix Doesn't match tag requirements
Milestone
Terminal v1.23

Comments

@valiko-ua
Copy link

valiko-ua commented Sep 5, 2024 •
edited
Loading

Windows Terminal version

1.22.2362.0

Windows build number

10.0.22631.4037

Steps to reproduce

  • Settings -> Actions -> Add New -> Add "Ctrl+l" (lowercase L) for "Clear Buffer". Press Save.
  • Open tab with "Command Prompt".
  • Execute "cd C:\Windows". Execute "dir" several times to fill the screen.
  • Press Ctrl+l (lowercase L).

Expected Behavior

Clear Buffer works fine in Windows Terminal v.1.20.11781.0.

Actual Behavior

Clear Buffer does not work in Windows Terminal Preview v.1.22.2362.0.

The same problem can be reproduced with "Ubuntu 24.04 LTS" tab (WSL2).

I've just noticed that pressing Ctrl+Shift+L works differently from Ctrl+L (but still broken). And I didn't assign Ctrl+Shift+L to anything.
@valiko-ua valiko-ua added Issue-Bug It either shouldn't be doing this or needs an investigation. Needs-Triage It's a new issue that the core contributor team needs to triage at the next triage meeting labels Sep 5, 2024
@zadjii-msft
Copy link
Member

@lhecker Didn't we fix this during the original #17510? I could have swore that I filed that, but I can't find it now

@elsaco
Copy link

elsaco commented Sep 5, 2024

@valiko-ua it's not the key binding. In 1.22.2362 the Clear buffer doesn't work. Fill the buffer with data and invoke the command via ctrl+shift+p. It won't clear the buffer!

@j4james
Copy link
Collaborator

j4james commented Sep 7, 2024

I think the problem is explained by the comment here:

terminal/src/cascadia/TerminalControl/ControlCore.cpp

Lines 2232 to 2238 in 544452d

// Send a signal to conpty to clear the buffer.
if (auto conpty{ _connection.try_as<TerminalConnection::ConptyConnection>() })
{
// ConPTY will emit sequences to sync up our buffer with its new
// contents.
conpty.ClearBuffer();
}

In the past when you asked conpty to clear its buffer, the vtengine would have pushed back an update that also cleared the buffer in the connected terminal, but that's not happening anymore. On the conhost side, the ClearBuffer signal is handled here:

terminal/src/host/PtySignalInputThread.cpp

Lines 185 to 201 in 544452d

void PtySignalInputThread::_DoClearBuffer() const
{
LockConsole();
auto Unlock = wil::scope_exit([&] { UnlockConsole(); });
// If the client app hasn't yet connected, stash the new size in the launchArgs.
// We'll later use the value in launchArgs to set up the console buffer
// We must be under lock here to ensure that someone else doesn't come in
// and set with `ConnectConsole` while we're looking and modifying this.
if (!_consoleConnected)
{
return;
}
auto& gci = ServiceLocator::LocateGlobals().getConsoleInformation();
THROW_IF_FAILED(gci.GetActiveOutputBuffer().ClearBuffer());
}

Which just calls the SCREEN_INFORMATION class here:

terminal/src/host/screenInfo.cpp

Lines 2142 to 2162 in 544452d

[[nodiscard]] HRESULT SCREEN_INFORMATION::ClearBuffer()
{
// Rotate the buffer to bring the cursor row to the top of the viewport.
const auto cursorPos = _textBuffer->GetCursor().GetPosition();
for (auto i = 0; i < cursorPos.y; i++)
{
_textBuffer->IncrementCircularBuffer();
}
// Erase everything below that point.
RETURN_IF_FAILED(SetCursorPosition({ 0, 1 }, false));
auto& engine = reinterpret_cast<OutputStateMachineEngine&>(_stateMachine->Engine());
engine.Dispatch().EraseInDisplay(DispatchTypes::EraseType::ToEnd);
// Restore the original cursor x offset, but now on the first row.
RETURN_IF_FAILED(SetCursorPosition({ cursorPos.x, 0 }, false));
_textBuffer->TriggerRedrawAll();
return S_OK;
}

That's just going to clear the conhost buffer. As far as I can see, there's nothing in that code that will emit sequences to sync it up with the terminal buffer.

@lhecker lhecker linked a pull request Sep 9, 2024 that will close this issue
Open
@microsoft-github-policy-service microsoft-github-policy-service bot added the In-PR This issue has a related PR label Sep 9, 2024
@lhecker lhecker mentioned this issue Sep 10, 2024
Closed
@Priyanka-Chauhan123 Priyanka-Chauhan123 added Area-Accessibility Issues related to accessibility HCL-E+D Accessibility tracking A11yWCAG Accessibility tracking HCL-WindowsTerminal Accessibility tracking A11ySev1 Accessibility tracking labels Sep 10, 2024
@carlos-zamora carlos-zamora added this to the Terminal v1.23 milestone Sep 11, 2024
@carlos-zamora carlos-zamora removed the Needs-Triage It's a new issue that the core contributor team needs to triage at the next triage meeting label Sep 11, 2024
@microsoft-github-policy-service microsoft-github-policy-service bot added the Needs-Tag-Fix Doesn't match tag requirements label Sep 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A11ySev1 Accessibility tracking A11yWCAG Accessibility tracking Area-Accessibility Issues related to accessibility HCL-E+D Accessibility tracking HCL-WindowsTerminal Accessibility tracking In-PR This issue has a related PR Issue-Bug It either shouldn't be doing this or needs an investigation. Needs-Tag-Fix Doesn't match tag requirements
Projects
1.22 Servicing Pipeline
Status: To Cherry Pick
Milestone
Terminal v1.23
Development

Successfully merging a pull request may close this issue.

Fix clear buffer command microsoft/terminal
6 participants
@elsaco @j4james @carlos-zamora @valiko-ua @zadjii-msft @Priyanka-Chauhan123