Skip to content

Fix VtSubstring helper method to correctly check chars copied #19240

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
Merged
daxian-dbw merged 1 commit into from
Mar 1, 2023
Merged

Fix VtSubstring helper method to correctly check chars copied #19240

daxian-dbw merged 1 commit into from
Mar 1, 2023

Conversation

@SteveL-MSFT
Copy link
Member

@SteveL-MSFT SteveL-MSFT commented Feb 28, 2023 •
edited
Loading

PR Summary

Couldn't figure out why ru-ru is affected as the code seems to should have been broken and nothing in the area was related to culture. The problem was with a check to exit after copying the expected number of characters to a new buffer. However, it was only looking at the offset which restarted at zero and would stop at the length, but it should only count when copying has started.

Manually validated that I could repro with ru-ru culture, but not with en-us culture and the fix does fix it in ru-ru culture as well as en-us.

PR Context

Fix #19231

PR Checklist

@pull-request-quantifier-deprecated
Copy link

pull-request-quantifier-deprecated bot commented Feb 28, 2023

This PR has 2 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       : +1 -1
Percentile : 0.8%

Total files changed: 1

Change summary by file extension:
.cs : +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 detected.
  • 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.

@ghost ghost assigned daxian-dbw Feb 28, 2023
@mklement0 mklement0 mentioned this pull request Feb 28, 2023
Closed
5 tasks
daxian-dbw
daxian-dbw approved these changes Mar 1, 2023
View reviewed changes
Copy link
Member

@daxian-dbw daxian-dbw left a comment

Choose a reason for hiding this comment

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

Couldn't figure out why ru-ru is affected as the code seems to should have been broken and nothing in the area was related to culture.

It turns out the formatting code does branch based on culture:

PowerShell/src/System.Management.Automation/FormatAndOutput/common/ComplexWriter.cs

Lines 437 to 444 in d554d06

if (s_cultureCollection.Contains(CultureInfo.CurrentCulture.TwoLetterISOLanguageName))
{
return GenerateLinesWithWordWrap(displayCells, val, firstLineLen, followingLinesLen);
}
else
{
return GenerateLinesWithoutWordWrap(displayCells, val, firstLineLen, followingLinesLen);
}

Six pre-selected cultures will go with the if block, including en-US. For ru-RU and other cultures, it will go with the else block. So, this VtSubstring method is not hit for this repro in the en-US culture.

@daxian-dbw daxian-dbw merged commit 9764e3c into PowerShell:master Mar 1, 2023
@daxian-dbw daxian-dbw added the CL-Engine Indicates that a PR should be marked as an engine change in the Change Log label Mar 1, 2023
@SteveL-MSFT SteveL-MSFT deleted the vtsubstring branch March 1, 2023 01:42
@iSazonov
Copy link
Collaborator

iSazonov commented Mar 1, 2023

Six pre-selected cultures will go with the if block, including en-US. For ru-RU and other cultures, it will go with the else block. So, this VtSubstring method is not hit for this repro in the en-US culture.

I don't see reasons why ru-RU is not in the list. Since we don't split words itself the rules for splitting by words is the same - delimiters are space and tab.

@ghost
Copy link

ghost commented Mar 14, 2023

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

Handy links:

@ghost
Copy link

ghost commented Apr 13, 2023

🎉v7.3.4 has been released which incorporates this pull request.:tada:

Handy links:

adityapatwardhan pushed a commit to adityapatwardhan/PowerShell that referenced this pull request Apr 25, 2023
@SteveL-MSFT @daxian-dbw
Fix VtSubstring helper method to correctly check chars copied (Powe…
9b2c125 
…rShell#19240)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@daxian-dbw daxian-dbw daxian-dbw approved these changes

Assignees

@daxian-dbw daxian-dbw

Labels

Backport-7.3.x-Done CL-Engine Indicates that a PR should be marked as an engine change in the Change Log Extra Small

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Some rows are invisible in output of long string of «Select-String»

3 participants

@SteveL-MSFT @iSazonov @daxian-dbw