Ignore failure attempting to set console window title #16948

SteveL-MSFT · 2022-03-02T16:49:01Z

PR Summary

Reported by a partner that they are using PowerShell console host in automation where there is no terminal window and SetConsoleWindowTitle call fails and the console host exits. Since this is a useful, but decorative feature, we should handle this gracefully by ignoring the Win32 API error and not attempt to set the window title subsequent times.

PR Checklist

src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleControl.cs

krishnayalavarthi

Looks good to me

src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleControl.cs

PaulHigin

Minor comment only.

src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleControl.cs

iSazonov

LGTM with one style comment.

iSazonov · 2022-03-10T06:23:00Z

src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleControl.cs

@@ -2494,6 +2494,8 @@ internal static string GetConsoleWindowTitle()
            return consoleTitle.ToString();
        }

+        private static bool dontSetConsoleWindowTitle;


Our style:

Suggested change

private static bool dontSetConsoleWindowTitle;

private static bool s_dontSetConsoleWindowTitle;

looks like the convention in the codebase is not an s_, but pascal casing instead of camel

codefactor wants to start with lowercase, so changing back to lowercase but not updating rest of codebase.

@SteveL-MSFT Please look our guidelines we follow for years https://github.com/PowerShell/PowerShell/blob/master/docs/dev-process/coding-guidelines.md#naming-conventions

Use camelCase to name internal and private fields and use readonly where possible. Prefix instance fields with , static fields with s and thread static fields with t. When used on static fields, readonly should come after static (i.e. static readonly not readonly static).

This says us to use s_dontSetConsoleWindowTitle

pull-request-quantifier · 2022-03-10T15:25:54Z

This PR has 7 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       : +7 -0
Percentile : 2.8%

Total files changed: 1

Change summary by file extension:
.cs : +7 -0

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? 👍 👌 👎 (Email)
Customize PullRequestQuantifier for this repository.

msftbot · 2022-03-18T14:00:43Z

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

msftbot · 2022-05-23T16:21:29Z

🎉v7.3.0-preview.4 has been released which incorporates this pull request.🎉

Handy links:

Release Notes

SteveL-MSFT requested review from daxian-dbw and anmenaga as code owners Mar 2, 2022

pull-request-quantifier bot added the Extra Small label Mar 2, 2022

msftbot bot assigned iSazonov Mar 2, 2022

iSazonov reviewed Mar 2, 2022

View changes

src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleControl.cs Outdated Show resolved Hide resolved

src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleControl.cs Outdated Show resolved Hide resolved

krishnayalavarthi reviewed Mar 2, 2022

View changes

src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleControl.cs Outdated Show resolved Hide resolved

krishnayalavarthi approved these changes Mar 2, 2022

View changes

krishnayalavarthi reviewed Mar 2, 2022

View changes

src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleControl.cs Outdated Show resolved Hide resolved

krishnayalavarthi approved these changes Mar 2, 2022

View changes

SteveL-MSFT force-pushed the setwindowtitle branch from 5fce629 to dc03d45 Compare Mar 2, 2022

This comment was marked as outdated.

Sign in to view

SteveL-MSFT changed the title ~~Ignore failure to console window title~~ Ignore failure attempting to set console window title Mar 3, 2022

SteveL-MSFT added 5 commits Mar 4, 2022

Ignore failure to console window title

d3ae412

add logging and handle specific known error case

e34b6e2

move comment to address codefactor

d760f67

fix static variable name

688518c

make static member private

dfc5c76

SteveL-MSFT force-pushed the setwindowtitle branch from dc03d45 to dfc5c76 Compare Mar 4, 2022

PaulHigin approved these changes Mar 9, 2022

View changes

src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleControl.cs Outdated Show resolved Hide resolved

SteveL-MSFT added 2 commits Mar 9, 2022

change to use default value for bool

52c731a

remove unncessary else

5fcecc9

iSazonov approved these changes Mar 10, 2022

View changes

SteveL-MSFT added 2 commits Mar 10, 2022

update static variable naming to match convention

e31bb99

change back to lowercase due to codefactor

846acf2

msftbot bot added the Review - Needed The PR is being reviewed label Mar 18, 2022

address Ilya's feedback

cdace0a

iSazonov approved these changes Mar 30, 2022

View changes

iSazonov merged commit 788ffde into PowerShell:master Mar 30, 2022
46 checks passed

msftbot bot removed the Review - Needed The PR is being reviewed label Mar 30, 2022

iSazonov added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Mar 30, 2022

SteveL-MSFT deleted the setwindowtitle branch Mar 30, 2022

Aug	SEP	Oct
	12
2021	2022	2023

Ignore failure attempting to set console window title #16948

Ignore failure attempting to set console window title #16948

SteveL-MSFT commented Mar 2, 2022 •

edited

krishnayalavarthi left a comment

This comment was marked as outdated.

PaulHigin left a comment

iSazonov left a comment

iSazonov Mar 10, 2022 •

edited

SteveL-MSFT Mar 10, 2022 •

edited

SteveL-MSFT Mar 10, 2022

iSazonov Mar 11, 2022

pull-request-quantifier bot commented Mar 10, 2022

What can I do to optimize my changes

How to interpret the change counts in git diff output

msftbot bot commented Mar 18, 2022

msftbot bot commented May 23, 2022

	private static bool dontSetConsoleWindowTitle;
	private static bool s_dontSetConsoleWindowTitle;

Ignore failure attempting to set console window title #16948

Ignore failure attempting to set console window title #16948

Conversation

SteveL-MSFT commented Mar 2, 2022 • edited

PR Summary

PR Checklist

krishnayalavarthi left a comment

This comment was marked as outdated.

PaulHigin left a comment

iSazonov left a comment

iSazonov Mar 10, 2022 • edited

Choose a reason for hiding this comment

SteveL-MSFT Mar 10, 2022 • edited

Choose a reason for hiding this comment

SteveL-MSFT Mar 10, 2022

Choose a reason for hiding this comment

iSazonov Mar 11, 2022

Choose a reason for hiding this comment

pull-request-quantifier bot commented Mar 10, 2022

What can I do to optimize my changes

How to interpret the change counts in git diff output

msftbot bot commented Mar 18, 2022

msftbot bot commented May 23, 2022

SteveL-MSFT commented Mar 2, 2022 •

edited

iSazonov Mar 10, 2022 •

edited

SteveL-MSFT Mar 10, 2022 •

edited