Fix formatting truncation to handle strings with VT sequences #17251

daxian-dbw · 2022-05-04T01:10:42Z

PR Summary

Fix formatting truncation to handle strings with VT sequences.
The main changes are in buffer cell length calculation, as well as adding VtSubstring implementations, which are used to get part of a string that may contain escape sequences.

With the changes in this PR, the formatting works fine with the demo scripts from #16700 (comment) and #16700 (comment):

function Get-DemoObjects {
    [PSCustomObject]@{PSTypeName = "User"; Name = "Bob Saggat"; Tenure = 2; Role = "Developer" }
    [PSCustomObject]@{PSTypeName = "User"; Name = "John Seymour"; Tenure = 6; Role = "Sw Engineer" }
    [PSCustomObject]@{PSTypeName = "User"; Name = "Billy Bob Thorton"; Tenure = 13; Role = "Senior DevOps Engineer" }
}

Get-DemoObjects |
    Format-Table @{Width = 10; Name = "Name"; E = { (@("`e[32m", "`e[34m", "`e[33m", "`e[31m", "`e[33m", "`e[34m", "`e[32m")[[array]::BinarySearch(@(3, 5, 8), $_.Tenure)]) + $_.Name + "`e[39m"}},
                 @{Width = 15; Name = "Role";  E = { $_.Role }}, 
                 @{Width = 3; Name = "YIR";  E = { $_.Tenure }}

Get-DemoObjects |
    Format-Table @{Width = 10; Name = "Name"; E = { (@("`e[32m", "`e[34m", "`e[33m", "`e[31m", "`e[33m", "`e[34m", "`e[32m")[[array]::BinarySearch(@(3, 5, 8), $_.Tenure)]) + $_.Name + "`e[39m"}},
                 @{Width = 15; Name = "Role";  E = {
                                -join $(switch -regex ($_.Role){
                                        "Senior" { "`e[42m" }
                                        "Engineer" { "`e[1;33m" }
                                    }) + $_.Role  + "`e[0m"}}, 
                 @{Width = 3; Name = "YIR";  E = { $_.Tenure }}

$PSStyle.OutputRendering = "Ansi"
(Get-DemoObjects) + (Get-DemoObjects) + 
(Get-DemoObjects) + (Get-DemoObjects) + 
(Get-DemoObjects) + (Get-DemoObjects) | 
    Format-Wide @{E = { (@("`e[32m", "`e[34m", "`e[33m", "`e[31m", "`e[33m", "`e[34m", "`e[32m")[[array]::BinarySearch(@(3, 5, 8), $_.Tenure)]) + $_.Name + "`e[39m"}} -co 2 | Out-String -Width 47

Get-DemoObjects | Format-Table @{Width = 10; Name = "Name"; E = { "`e[33m" + $_.Name } }, 
                               @{Width = 15; Name = "Role"; E = { $_.Role }},
                               @{Width = 3;  Name = "YIR";  E = { $_.Tenure }}

Get-DemoObjects | Format-Table @{Width = 10; Name = "Name"; E = { "`e[1;33m" + $_.Name } }, 
                               @{Width = 15; Name = "Role"; E = { $_.Role }},
                               @{Width = 3;  Name = "YIR";  E = { $_.Tenure }}

Using the repro provided in #16700 (comment), now the formatting truncation and alignment work as expected:

Out-String works as well:

PR Checklist

pull-request-quantifier · 2022-05-04T18:48:09Z

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

Quantification details

Label      : Large
Size       : +232 -119
Percentile : 75.1%

Total files changed: 10

Change summary by file extension:
.cs : +150 -118
.ps1 : +81 -0
.json : +1 -1

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.

daxian-dbw · 2022-05-04T19:40:08Z

src/System.Management.Automation/FormatAndOutput/out-console/ConsoleLineOutput.cs

+        /// <summary>
+        /// The default buffer cell calculation already works for the PowerShell console host and Visual studio code host.
+        /// </summary>
+        private static readonly HashSet<string> s_psHost = new(StringComparer.Ordinal) { "ConsoleHost", "Visual Studio Code Host" };


@SeeminglyScience Now that the default buffer cell calculation takes into account escape sequences and CJK characters, I think we can make ConsoleHost and VSCode host to use the default DisplayCells instead of calling into the host specific LengthInBufferCells method. Let me know if you have any concerns.

@SeeminglyScience Now that the default buffer cell calculation takes into account escape sequences and CJK characters, I think we can make ConsoleHost and VSCode host to use the default DisplayCells instead of calling into the host specific LengthInBufferCells method. Let me know if you have any concerns.

I agree! VSCode just redirects to ConsoleHost*'s implementation so shouldn't need any changes there.

Also does this mean that piping to line output writers that aren't host aware should work now too? 😮 (e.g. Out-String and less.exe would calculate the wrong value width because they never call LengthInBufferCells)

Yes, Out-String works too. I will add a screenshot to the description about this.
[update] screenshot added. Also add it here:

PaulHigin

LGTM

SeeminglyScience

Very clever fix, well done! LGTM ❤️

msftbot bot assigned iSazonov May 4, 2022

pull-request-quantifier bot added the Large label May 4, 2022

daxian-dbw force-pushed the ans branch from 8347b46 to 1bfb8ea Compare May 4, 2022

pull-request-quantifier bot added Extra Large and removed Large labels May 4, 2022

daxian-dbw added 4 commits May 4, 2022

Fix formatting truncation to handle strings with VT sequences

7cd2f95

Fix a minor issue + add diagnosis to test

70b4aaf

Try to fix the test

aa1a3e5

Update cgmanifest.json and address some CodeFactor issues

daeabf4

daxian-dbw force-pushed the ans branch from d98a04c to daeabf4 Compare May 4, 2022

pull-request-quantifier bot added Large and removed Extra Large labels May 4, 2022

daxian-dbw marked this pull request as ready for review May 4, 2022

daxian-dbw requested review from TravisEz13, adityapatwardhan, anmenaga and PaulHigin as code owners May 4, 2022

Minor fix

dbe42a5

daxian-dbw requested review from SteveL-MSFT and SeeminglyScience and removed request for anmenaga, TravisEz13 and adityapatwardhan May 4, 2022

Add a comment

d1824b2

daxian-dbw added the CL-Engine label May 4, 2022

daxian-dbw reviewed May 4, 2022

View changes

PaulHigin approved these changes May 4, 2022

View changes

SeeminglyScience approved these changes May 5, 2022

View changes

daxian-dbw mentioned this pull request May 6, 2022

Fix list view to not leak VT decorations #17262

Merged

13 tasks

daxian-dbw assigned daxian-dbw and unassigned iSazonov May 6, 2022

daxian-dbw merged commit 4c6c4f3 into PowerShell:master May 6, 2022
50 checks passed

daxian-dbw deleted the ans branch May 6, 2022

Apr	MAY	Jun
	11
2021	2022	2023

PowerShell / PowerShell Public

Fix formatting truncation to handle strings with VT sequences #17251

Fix formatting truncation to handle strings with VT sequences #17251

daxian-dbw commented May 4, 2022 •

edited

pull-request-quantifier bot commented May 4, 2022

What can I do to optimize my changes

How to interpret the change counts in git diff output

daxian-dbw May 4, 2022

SeeminglyScience May 5, 2022

daxian-dbw May 5, 2022 •

edited

PaulHigin left a comment

SeeminglyScience left a comment

PowerShell / PowerShell Public

Fix formatting truncation to handle strings with VT sequences #17251

Fix formatting truncation to handle strings with VT sequences #17251

Conversation

daxian-dbw commented May 4, 2022 • edited

PR Summary

PR Checklist

pull-request-quantifier bot commented May 4, 2022

What can I do to optimize my changes

How to interpret the change counts in git diff output

daxian-dbw May 4, 2022

Choose a reason for hiding this comment

SeeminglyScience May 5, 2022

Choose a reason for hiding this comment

daxian-dbw May 5, 2022 • edited

Choose a reason for hiding this comment

PaulHigin left a comment

SeeminglyScience left a comment

daxian-dbw commented May 4, 2022 •

edited

daxian-dbw May 5, 2022 •

edited