Refactor Escape() method by iSazonov · Pull Request #18230 · PowerShell/PowerShell

iSazonov · 2022-10-06T12:57:32Z

PR Summary

Moved from #18154

Exclude using LINQ and Utils.Separators.StarOrQuestion (the const is not removed in the PR to avoid merge conflitcs).

BenchmarkDotNet=v0.13.2, OS=Windows 10 (10.0.19044.2006/21H2/November2021Update)
Intel Core i5-2410M CPU 2.30GHz (Sandy Bridge), 1 CPU, 4 logical and 2 physical cores
.NET SDK=7.0.100-rc.1.22431.12
  [Host]     : .NET 7.0.0 (7.0.22.42610), X64 RyuJIT AVX
  DefaultJob : .NET 7.0.0 (7.0.22.42610), X64 RyuJIT AVX

Method	Categories	path	Mean	Ratio	Code Size	Allocated	Alloc Ratio
Orig_Escape_All	All	c:\	15.45 ns	1.00	511 B	-	NA
New_Escape_All	All	c:\	13.64 ns	0.88	516 B	-	NA

Orig_Escape_All	All	c:\*	48.22 ns	1.00	511 B	32 B	1.00
New_Escape_All	All	c:\*	35.58 ns	0.75	516 B	32 B	1.00

Orig_Escape_All	All	c:\us(...)ents\ [24]	74.39 ns	1.00	511 B	-	NA
New_Escape_All	All	c:\us(...)ents\ [24]	72.20 ns	0.97	516 B	-	NA

Orig_Escape_All	All	c:\us(...)nts\ [25]*	115.30 ns	1.00	511 B	80 B	1.00
New_Escape_All	All	c:\us(...)nts\* [25]	98.49 ns	0.85	516 B	80 B	1.00

Old_Escape_Brackets	Brackets	c:\	15.58 ns	?	511 B	-	?
New_Escape_Brackets	Brackets	c:\	12.48 ns	?	519 B	-	?

Old_Escape_Brackets	Brackets	c:\[	48.80 ns	?	511 B	32 B	?
New_Escape_Brackets	Brackets	c:\[	34.37 ns	?	519 B	32 B	?

Old_Escape_Brackets	Brackets	c:\us(...)ents\ [24]	75.06 ns	?	511 B	-	?
New_Escape_Brackets	Brackets	c:\us(...)ents\ [24]	60.08 ns	?	519 B	-	?

Old_Escape_Brackets	Brackets	c:\us(...)nts\[ [25]	116.00 ns	?	511 B	80 B	?
New_Escape_Brackets	Brackets	c:\us(...)nts\[ [25]	86.48 ns	?	519 B	80 B	?

PR Context

PR Checklist

Exclude using LINQ and Utils.Separators.StarOrQuestion Update tests

xtqqczze · 2022-10-06T13:44:31Z

-
-            string s = null;
+                    char ch = pattern[i];
+                    if (ch == '[' || ch == ']')


Suggested change

if (ch == '[' || ch == ']')

if (ch is '[' or ']')

@xtqqczze The PR is only for removing Utils.Separators.StarOrQuestion. No plans for style changes.

xtqqczze · 2022-10-06T13:47:13Z

-                // if it is a wildcard char, escape it
-                //
-                if (IsWildcardChar(ch) && !charsNotToEscape.Contains(ch))
+                for (int i = 0; i < pattern.Length; i++)


Suggested change

for (int i = 0; i < pattern.Length; i++)

foreach (char ch in pattern)

xtqqczze · 2022-10-06T13:48:36Z

            else
            {
-                s = new string(temp.Slice(0, tempIndex));
+                for (int i = 0; i < pattern.Length; i++)


Suggested change

for (int i = 0; i < pattern.Length; i++)

foreach (char ch in pattern)

xtqqczze · 2022-10-06T14:37:17Z

@@ -233,33 +222,34 @@ internal static string Escape(string pattern, char[] charsNotToEscape)
            Span<char> temp = pattern.Length < StackAllocThreshold ? stackalloc char[pattern.Length * 2 + 1] : new char[pattern.Length * 2 + 1];


This looks like a existing bug, the condition should probably have been pattern.Length * 2 < StackAllocThreshold.

I suggest refactoring to the recommended pattern (and in Unescape too):

Suggested change

Span<char> temp = pattern.Length < StackAllocThreshold ? stackalloc char[pattern.Length * 2 + 1] : new char[pattern.Length * 2 + 1];

int lengthRequired = pattern.Length * 2 + 1;

Span<char> temp = lengthRequired <= StackAllocThreshold ? stackalloc char[StackAllocThreshold] : new char[lengthRequired];

pull-request-quantifier-deprecated · 2022-10-07T10:18:16Z

This PR has 41 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       : +20 -21
Percentile : 16.4%

Total files changed: 3

Change summary by file extension:
.cs : +20 -21

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 · 2022-10-14T14:01:28Z

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

Refactor Escape() method

c5a1f69

Exclude using LINQ and Utils.Separators.StarOrQuestion Update tests

iSazonov assigned daxian-dbw Oct 6, 2022

pull-request-quantifier-deprecated Bot added the Extra Small label Oct 6, 2022

iSazonov requested a review from daxian-dbw October 6, 2022 12:57

iSazonov mentioned this pull request Oct 6, 2022

Remove static constants #18154

Merged

22 tasks

xtqqczze reviewed Oct 6, 2022

View reviewed changes

Fix typo.

20845cc

iSazonov closed this Oct 7, 2022

iSazonov reopened this Oct 7, 2022

ghost added the Review - Needed The PR is being reviewed label Oct 14, 2022

iSazonov closed this Apr 23, 2023

ghost removed the Review - Needed The PR is being reviewed label Apr 23, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor Escape() method#18230

Refactor Escape() method#18230
iSazonov wants to merge 2 commits intoPowerShell:masterfrom
iSazonov:perf-escape

iSazonov commented Oct 6, 2022

Uh oh!

xtqqczze Oct 6, 2022

Uh oh!

iSazonov Oct 6, 2022

Uh oh!

xtqqczze Oct 6, 2022

Uh oh!

xtqqczze Oct 6, 2022

Uh oh!

xtqqczze Oct 6, 2022

Uh oh!

pull-request-quantifier-deprecated Bot commented Oct 7, 2022

What can I do to optimize my changes

How to interpret the change counts in git diff output

Uh oh!

ghost commented Oct 14, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	for (int i = 0; i < pattern.Length; i++)
	foreach (char ch in pattern)

		@@ -233,33 +222,34 @@ internal static string Escape(string pattern, char[] charsNotToEscape)
		Span<char> temp = pattern.Length < StackAllocThreshold ? stackalloc char[pattern.Length * 2 + 1] : new char[pattern.Length * 2 + 1];

	Span<char> temp = pattern.Length < StackAllocThreshold ? stackalloc char[pattern.Length * 2 + 1] : new char[pattern.Length * 2 + 1];
	int lengthRequired = pattern.Length * 2 + 1;
	Span<char> temp = lengthRequired <= StackAllocThreshold ? stackalloc char[StackAllocThreshold] : new char[lengthRequired];

Conversation

iSazonov commented Oct 6, 2022

PR Summary

PR Context

PR Checklist

Uh oh!

xtqqczze Oct 6, 2022

Choose a reason for hiding this comment

Uh oh!

iSazonov Oct 6, 2022

Choose a reason for hiding this comment

Uh oh!

xtqqczze Oct 6, 2022

Choose a reason for hiding this comment

Uh oh!

xtqqczze Oct 6, 2022

Choose a reason for hiding this comment

Uh oh!

xtqqczze Oct 6, 2022

Choose a reason for hiding this comment

Uh oh!

pull-request-quantifier-deprecated Bot commented Oct 7, 2022

What can I do to optimize my changes

How to interpret the change counts in git diff output

Uh oh!

ghost commented Oct 14, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants