GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Use `NotifyEndApplication` to re-enable VT mode instead of doing it in `InputLoop.Run` by daxian-dbw · Pull Request #16612 · PowerShell/PowerShell

Conversation

@daxian-dbw

@daxian-dbw Dongbo Wang (daxian-dbw) commented Dec 13, 2021

Copy link
Copy Markdown
Member

PR Summary

This is a refactor of the changes in #14413 -- use NotifyEndApplication to re-enable VT mode instead of doing it in InputLoop.Run, so that we run this code only after invoking native commands.

PR Context

I was reviewing the use of NotifyBeginApplication and NotifyEndApplication for some related issues in VS Code extension, and .NET Interactive Notebook, and found that the code to re-enable VT mode in ConsoleHost is not done in NotifyEndApplication, but in InputLoop.Run, so the code runs for every command execution instead of only after executable invocation. This PR attempts to refactor the fix in #14413 to only do it after execution of a native command.

PR Checklist

  • PR has a meaningful title
    • Use the present tense and imperative mood when describing your changes
  • Summarized changes
  • Make sure all .h, .cpp, .cs, .ps1 and .psm1 files have the correct copyright header
  • This PR is ready to merge and is not Work in Progress.
    • If the PR is work in progress, please add the prefix WIP: or [ WIP ] to the beginning of the title (the WIP bot will keep its status check at Pending while the prefix is present) and remove the prefix when the PR is ready.
  • Breaking changes
    • None
    • OR
    • Experimental feature(s) needed
      • Experimental feature name(s):
  • User-facing changes
    • Not Applicable
    • OR
    • Documentation needed
      • Issue filed:
  • Testing - New and feature
    • N/A or can only be tested interactively
    • OR
    • Make sure you've added a new test if existing tests do not effectively test the code changed
  • Tooling
    • I have considered the user experience from a tooling perspective and don't believe tooling will be impacted.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

SeeminglyScience reacted with heart emoji
All reactions
  • ❤️ 1 reaction
@daxian-dbw
Use NotifyEndApplication to re-enable VT mode
5799ce7
@daxian-dbw
Dongbo Wang (daxian-dbw) requested a review from Steve Lee (SteveL-MSFT) December 13, 2021 22:56
@daxian-dbw
Dongbo Wang (daxian-dbw) requested a review from Andrew (anmenaga) as a code owner December 13, 2021 22:56
@ghost ghost assigned Ilya (iSazonov) Dec 13, 2021
@pull-request-quantifier-deprecated pull-request-quantifier-deprecated Bot added the Extra Small label Dec 13, 2021
@pull-request-quantifier-deprecated

pull-request-quantifier-deprecated Bot commented Dec 13, 2021

Copy link
Copy Markdown

This PR has 44 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!


Quantification details

Label      : Extra Small
Size       : +22 -22
Percentile : 17.6%

Total files changed: 3

Change summary by file extension:
.cs : +22 -22

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

  • Fast and predictable releases to production:
    • Optimal size changes are more likely to be reviewed faster with fewer
      iterations.
    • Similarity in low PR complexity drives similar review times.
  • Review quality is likely higher as complexity is lower:
    • Bugs are more likely to be detected.
    • Code inconsistencies are more likely to be detetcted.
  • Knowledge sharing is improved within the participants:
    • Small portions can be assimilated better.
  • Better engineering practices are exercised:
    • Solving big problems by dividing them in well contained, smaller problems.
    • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

  • Use the PullRequestQuantifier to quantify your PR accurately
    • Create a context profile for your repo using the context generator
    • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
    • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
    • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
  • Change your engineering behaviors
    • For PRs that fall outside of the desired spectrum, review the details and check if:
      • Your PR could be split in smaller, self-contained PRs instead
      • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

  • One line was added: +1 -0
  • One line was deleted: +0 -1
  • One line was modified: +1 -1 (git diff doesn't know about modified, it will
    interpret that line like one addition plus one deletion)
  • Change percentiles: Change characteristics (addition, deletion, modification)
    of this PR in relation to all other PRs within the repository.


Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

daxian-dbw
Dongbo Wang (daxian-dbw) commented Dec 13, 2021
View reviewed changes
Comment thread src/System.Management.Automation/engine/NativeCommandProcessor.cs
if (_runStandAlone)
{
this.Command.Context.EngineHostInterface.NotifyBeginApplication();
_hasNotifiedBeginApplication = true;

@daxian-dbw Dongbo Wang (daxian-dbw) Dec 13, 2021

Copy link
Copy Markdown
Member Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If a native process tweaks the window title, it will do so no matter it's running StandAlone or in a pipeline. So, we should actually always call NotifyBeginApplication and NotifyEndApplication before and after running a native command. Therefore, I moved this code out of the if (_runStandAlone) block.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Comment thread src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterface.cs
if (outputMode.HasFlag(ConsoleControl.ConsoleModes.VirtualTerminal))
{
return true;
}

@daxian-dbw Dongbo Wang (daxian-dbw) Dec 13, 2021

Copy link
Copy Markdown
Member Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the outputMode already has VirtualTerminal enabled, no need to set the mode again.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
iSazonov
Ilya (iSazonov) approved these changes Dec 14, 2021
View reviewed changes
Comment thread src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHost.cs
if (ui.SupportsVirtualTerminal)
{
// Re-enable VT mode if it was previously enabled, as a native command may have turned it off.
ui.TryTurnOnVirtualTerminal();

@iSazonov Ilya (iSazonov) Dec 14, 2021

Copy link
Copy Markdown
Collaborator

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Interesting, is such console operations expensive?
In line 1105 we have already requested a handle and set mode, now TryTurnOnVirtualTerminal does the operations again. It seems we could do perf optimization.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

@daxian-dbw Dongbo Wang (daxian-dbw) Dec 14, 2021

Copy link
Copy Markdown
Member Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very likely not expensive, especially if this is done only after native command execution. The handle is already cached, GetActiveScreenBufferHandle() returns a cached output handle.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

iSazonov reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
@iSazonov Ilya (iSazonov) added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Dec 14, 2021
@daxian-dbw

Dongbo Wang (daxian-dbw) commented Dec 17, 2021

Copy link
Copy Markdown
Member Author

Steve Lee (@SteveL-MSFT) and Andrew (@anmenaga) Can you please review when you have time? Thanks!

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@ghost ghost added the Review - Needed The PR is being reviewed label Dec 25, 2021
@ghost

Deleted user (ghost) commented Dec 25, 2021

Copy link
Copy Markdown

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@daxian-dbw

Dongbo Wang (daxian-dbw) commented Jan 3, 2022

Copy link
Copy Markdown
Member Author

Steve Lee (@SteveL-MSFT) and Andrew (@anmenaga) gentle ping :) Please review when you have time, thanks!

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@ghost ghost removed the Review - Needed The PR is being reviewed label Jan 3, 2022
@daxian-dbw

Dongbo Wang (daxian-dbw) commented Jan 7, 2022

Copy link
Copy Markdown
Member Author

Steve Lee (@SteveL-MSFT) and Andrew (@anmenaga) Gentle ping again :) Please take a look when you have time, thanks!

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@SeeminglyScience Patrick Meinecke (SeeminglyScience) mentioned this pull request Jan 13, 2022
External application leaks something ANSI-Corrupting into PowerShell session #16741
Closed
5 tasks done
anmenaga
Andrew (anmenaga) approved these changes Jan 13, 2022
View reviewed changes

@anmenaga Andrew (anmenaga) left a comment

Copy link
Copy Markdown

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.
Interesting scenario.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@daxian-dbw

Dongbo Wang (daxian-dbw) commented Jan 14, 2022

Copy link
Copy Markdown
Member Author

Thanks Andrew (@anmenaga) for taking a look!
Ilya (@iSazonov) I think this PR is ready to merge, thanks!

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@iSazonov
Ilya (iSazonov) merged commit 186d6be into PowerShell:master Jan 14, 2022
@iSazonov

Ilya (iSazonov) commented Jan 14, 2022

Copy link
Copy Markdown
Collaborator

Final notices:

  1. Maybe interesting for you End of line cursor position differences when app is run in Windows Terminal microsoft/terminal#8312 (comment) (with related references)
  2. Here all is about output to a console but should we think about input too?
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@daxian-dbw
Dongbo Wang (daxian-dbw) deleted the refactor branch January 14, 2022 17:12
TrapGodBrim pushed a commit to TrapGodBrim/PowerShell that referenced this pull request Jan 19, 2022
@daxian-dbw @TrapGodBrim
Use NotifyEndApplication to re-enable VT mode (PowerShell#16612)
750583c
Use NotifyEndApplication to re-enable VT mode instead of doing it in InputLoop.Run, so that we run this code only after invoking native commands
@PatTheMav Patrick Heyer (PatTheMav) mentioned this pull request Jan 20, 2022
Redirection of external command output breaks ANSI sequences #16775
Closed
5 tasks done
@ghost

Deleted user (ghost) commented Feb 24, 2022

Copy link
Copy Markdown

🎉v7.3.0-preview.2 has been released which incorporates this pull request.:tada:

Handy links:

  • Release Notes
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@PatTheMav Patrick Heyer (PatTheMav) mentioned this pull request Mar 13, 2022
CI: Unified build scripts for all platforms obsproject/obs-deps#98
Merged
6 tasks done
@SeeminglyScience Patrick Meinecke (SeeminglyScience) mentioned this pull request Oct 17, 2022
Select-String doesn't render VT (ANSI) escape sequences in its for-display output with input from external programs on Windows #18294
Closed
5 tasks done
@Herrmel Herrmel mentioned this pull request Dec 16, 2022
Streamed executable output prints Ansi Escaping in Write-* Commandlets #18771
Closed
5 tasks done
@mklement0 Michael Klement (mklement0) mentioned this pull request Feb 7, 2023
Consider implicitly activating VT / ANSI escape-sequence support for native programs in conhost.exe console windows on Windows #19101
Closed
@mklement0 Michael Klement (mklement0) mentioned this pull request Mar 30, 2023
Selective disabling/re-enabling of VT support (ANSI escape sequences) is broken #19425
Closed
5 tasks done
@Herrmel Herrmel mentioned this pull request Jun 15, 2023
Problems with enabling Virtual Terminal Mode when streaming program output on conhost #19813
Closed
5 tasks done
@mklement0 Michael Klement (mklement0) mentioned this pull request Dec 11, 2023
conhost.exe console windows on Windows: cmdlets, e.g. Select-String, do not render VT (ANSI) escape sequences in their for-display output with direct input from native (external) programs #20898
Open
5 tasks done
Thatgfsj (Thatgfsj) pushed a commit to Thatgfsj-contribs/PowerShell that referenced this pull request Aug 6, 2026
@daxian-dbw
Use NotifyEndApplication to re-enable VT mode (PowerShell#16612)
f3593f5
Use NotifyEndApplication to re-enable VT mode instead of doing it in InputLoop.Run, so that we run this code only after invoking native commands
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@iSazonov Ilya (iSazonov) iSazonov approved these changes
@SteveL-MSFT Steve Lee (SteveL-MSFT) Awaiting requested review from SteveL-MSFT
+1 more reviewer
@anmenaga Andrew (anmenaga) anmenaga approved these changes
Reviewers whose approvals may not affect merge requirements

Uh oh!

There was an error while loading. Please reload this page.

Assignees

@iSazonov Ilya (iSazonov)

Labels

CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log Extra Small

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

3 participants

@daxian-dbw @iSazonov @anmenaga
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.