Remove static constants #18154

iSazonov · 2022-09-24T10:07:07Z

PR Summary

Please review commit by commit.

Historically PowerShell code contains a lot of static constants because of limitations in old .Net APIs. For example, now we have string.Split(char) and can use it instead of string.Split(char[]).
I had to refactor some methods.

Escape() method now is more short, simple, clear and fast - now we exactly point chars we want to escape.
GetModuleNameAndVersion() method is refactored a bit. Since all paths have been collected from file system it makes no sense to take into account alternative directory separator.
PathSearchTrimEnd is removed based on Why TrimEndChars was removed? dotnet/runtime#76122 (comment)
(for ex., now we don't remove trail spaces that are valid in file names)

PR Context

PR Checklist

iSazonov · 2022-09-25T08:26:01Z

src/System.Management.Automation/engine/CommandSearcher.cs

It is requested by analyzer.

xtqqczze · 2022-09-26T00:18:57Z

I suggest splitting PathSearchTrimEnd changes.

xtqqczze · 2022-09-26T20:48:02Z

We could avoid some string allocations with the following IndexOfAny<T> overloads, available since .NET Core 2.1:

daxian-dbw

Left 2 comments. A lot of changes will be gone once addressing them, so I will wait after that to review the rest changes.

src/Microsoft.PowerShell.Security/security/SecureStringCommands.cs

daxian-dbw · 2022-09-26T21:59:36Z

src/System.Management.Automation/engine/CommandCompletion/CompletionAnalysis.cs

This is less readable than the existing code.

You will need to reason that "\r\n" will be cast to ReadOnlySpan and then the chars are used instead of the string itself. Also, I don't think the saving is measurable.

It's helpful to keep all separators together in Utils.Separators, for looking up and referencing.

@daxian-dbw

We can get better codegen using the char overloads:

Suggested change

var index = stringToComplete.AsSpan().IndexOfAny("\r\n");

var index = stringToComplete.AsSpan().IndexOfAny('\r', '\n');

https://sharplab.io/#v2:C4LghgzgtgPgAgJgIwFgBQcDMACR2DC2A3utmbjgJYB2w2AsgAwAUcSj2EAlMaef3ADsnAHQBBCAGUADmGrMuIgJLUAJgFMAHgHkAZmOoBPZgCIAOgCcz1E1wDcfMgF9HFbDTr0krdpx4k0fgFhCHEpWXlFFQ0dfSNmAHJLBIAabCTqBPtXFzQnIA===

Yes, we should use this overload.

xtqqczze · 2022-09-26T00:09:58Z

src/System.Management.Automation/engine/CommandSearcher.cs

Suggested change

if (_commandOrigin == CommandOrigin.Runspace && _commandName.AsSpan().IndexOfAny("\\/:") >= 0)

if (_commandOrigin == CommandOrigin.Runspace && _commandName.AsSpan().IndexOfAny('\\', '/', ':') >= 0)

https://sharplab.io/#v2:C4LghgzgtgPgAgJgIwFgBQcDMACR2DC2A3utmbjgJYB2w2AsgAwAUcSj2EAlMaef3ADsnAHQBBCAGUADmGrMuIgJLUAJgFMAHgHkAZmOoBPZgCIAOmYD0IE1wDcfMgF9HFbDTr0krdpx4k0fgFhCHEpWXlFFQ0dfSNmAHILBIAabATLVPSQBPtXFzQnIA===

It is a question for .Net team why these options have so different codegen.

One reason must be IndexOfAny("a-string") requires implicit casting from string to ReadOnlySpan<char>.
We should use the explicit overloads instead.

Done.

I opened dotnet/runtime#76354

src/System.Management.Automation/engine/CommandDiscovery.cs

xtqqczze · 2022-09-26T20:58:03Z

src/System.Management.Automation/engine/CommandDiscovery.cs

Suggested change

var secondBackslash = moduleCommandName.IndexOf('\\');

int secondBackslash = moduleCommandName.IndexOf('\\');

This PR already touches this line so we can fix code style too?

There is an enormous number of var. It is better to fix in another PR if we would want.

src/System.Management.Automation/engine/CommandCompletion/CompletionAnalysis.cs

iSazonov · 2022-09-29T09:19:20Z

src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs

-                if (useLiteralPath && LocationGlobber.StringContainsGlobCharacters(wordToComplete))
+                if (useLiteralPath)
                {
-                    wordToComplete = WildcardPattern.Escape(wordToComplete, Utils.Separators.StarOrQuestion);


You point to removed line.

src/System.Management.Automation/engine/CommandSearcher.cs

This reverts commit d0eccf5.

src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs

src/System.Management.Automation/engine/CommandCompletion/CompletionAnalysis.cs

xtqqczze · 2022-09-29T20:41:39Z

I suggest changes to CompletionCompleters.NativeCompletionVariableCommands are split as well.

src/System.Management.Automation/engine/NativeCommandProcessor.cs

src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs

src/System.Management.Automation/engine/regex.cs

iSazonov · 2022-10-04T06:23:12Z

I don't think it's really worth the changes.

My intention was to remove static initializations (not just these) that slow down startup. If you don't find it useful, you can close this PR. Sorry for wasting your time.

daxian-dbw · 2022-10-04T17:03:48Z

@iSazonov I didn't mean to frustrate you and I absolutely appreciate your intention for starting this work (this is not a simple change and you obviously put lots of effort).

I do agree with the gist of your idea, and that's why I spent time going through the changes here. But we need some compromises, for example, for IndexOfAny('\\', '/', ':'), how about we have Separators.DirectoryOrDrive to be const string of "\\/:", and then use it as IndexOfAny(Separator.DirectoryOrDrive)? With this, there would be less changes, which is easier for you to change as well as for others to review. I'm not asking for doing this for all existing members in Separatos, for those with single character values, I think you are right that we don't need to create a const member for them.

Also, it would be less obstacles to get the PR in if there are not semantic changes bundled together, such as the changes to regex.Escape. If you do think that's faster, then get the measurement to prove it and open a separate PR for it. Mixing them in one PR makes it harder to push it through.

iSazonov · 2022-10-04T17:27:21Z

I didn't mean to frustrate you

I know :-)

It's easier if you use the commits you find useful. You can delete the rest. Disagreement about personal preferences is not something worth wasting our time on.

This reverts commit 26e5414.

This reverts commit 45a8277.

iSazonov · 2022-10-05T17:32:17Z

Escape and DirectoryOrDrive reverted.

iSazonov · 2022-10-06T12:58:39Z

Escape was moved to #18230

ghost · 2022-10-13T14:01:27Z

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

pull-request-quantifier-deprecated · 2022-10-24T23:41:14Z

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

Quantification details

Label      : Medium
Size       : +50 -63
Percentile : 42.6%

Total files changed: 27

Change summary by file extension:
.cs : +50 -63

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.

daxian-dbw

LGTM

iSazonov · 2022-10-27T03:10:45Z

@daxian-dbw Could you please merge?

daxian-dbw · 2022-10-27T22:25:54Z

Thanks for the reminder!

iSazonov added 2 commits September 24, 2022 12:30

Replace Utils.Separators.Backslash

1ca2e7a

Replace Utils.Separators.Directory

541b6f2

iSazonov added the CL-Performance Indicates that a PR should be marked as a performance improvement in the Change Log label Sep 24, 2022

iSazonov assigned daxian-dbw Sep 24, 2022

pull-request-quantifier-deprecated bot added the Medium label Sep 24, 2022

iSazonov force-pushed the remove-static branch 5 times, most recently from 3c8bb42 to 1c39590 Compare September 24, 2022 19:10

iSazonov marked this pull request as ready for review September 25, 2022 08:18

iSazonov requested review from PaulHigin, SteveL-MSFT, TravisEz13, adityapatwardhan and anmenaga as code owners September 25, 2022 08:18

iSazonov commented Sep 25, 2022

View reviewed changes

src/System.Management.Automation/engine/CommandSearcher.cs Outdated

Copy link

Collaborator Author

iSazonov Sep 25, 2022

Choose a reason for hiding this comment

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

It is requested by analyzer.

iSazonov force-pushed the remove-static branch 2 times, most recently from c5dc0f3 to 05022a1 Compare September 26, 2022 04:54

daxian-dbw requested changes Sep 26, 2022

View reviewed changes

ghost added Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept and removed Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept labels Sep 26, 2022

iSazonov mentioned this pull request Sep 27, 2022

Remove PathSearchTrimEnd #18166

Closed

22 tasks

xtqqczze reviewed Sep 28, 2022

View reviewed changes

iSazonov added 4 commits September 29, 2022 10:07

Replace Utils.Separators.DirectoryOrDrive

45a8277

Replace Utils.Separators.Colon

77426e4

Replace Utils.Separators.Dot

d11e4e8

Replace Utils.Separators.Pipe

c84ff3f

iSazonov commented Sep 29, 2022

View reviewed changes

daxian-dbw requested changes Sep 29, 2022

View reviewed changes

src/System.Management.Automation/engine/CommandSearcher.cs Show resolved Hide resolved

ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Sep 29, 2022

Revert "Remove Utils.Separators.PathSearchTrimEnd"

851b776

This reverts commit d0eccf5.

ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Sep 29, 2022

xtqqczze reviewed Sep 29, 2022

View reviewed changes

src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs Outdated Show resolved Hide resolved

xtqqczze reviewed Sep 29, 2022

View reviewed changes

src/System.Management.Automation/engine/CommandCompletion/CompletionAnalysis.cs Show resolved Hide resolved

daxian-dbw reviewed Oct 3, 2022

View reviewed changes

src/System.Management.Automation/engine/NativeCommandProcessor.cs Outdated Show resolved Hide resolved

src/System.Management.Automation/engine/CommandCompletion/CompletionCompleters.cs Outdated Show resolved Hide resolved

daxian-dbw reviewed Oct 3, 2022

View reviewed changes

src/System.Management.Automation/engine/regex.cs Outdated Show resolved Hide resolved

iSazonov added 2 commits October 5, 2022 22:24

Revert "Replace Utils.Separators.StarOrQuestion"

bfd8bc9

This reverts commit 26e5414.

Revert "Replace Utils.Separators.DirectoryOrDrive"

997789f

This reverts commit 45a8277.

iSazonov mentioned this pull request Oct 6, 2022

Refactor Escape() method #18230

Closed

22 tasks

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

Avoid 'AsSpan.TrimEnd(string)'

7ee026b

daxian-dbw approved these changes Oct 24, 2022

View reviewed changes

ghost removed the Review - Needed The PR is being reviewed label Oct 27, 2022

daxian-dbw merged commit 8965af3 into PowerShell:master Oct 27, 2022

iSazonov deleted the remove-static branch October 28, 2022 03:10

anmenaga mentioned this pull request Sep 12, 2023

Fixing PS 7.4 regression that is breaking DSCv3 #20268

Merged

22 tasks

	var index = stringToComplete.AsSpan().IndexOfAny("\r\n");
	var index = stringToComplete.AsSpan().IndexOfAny('\r', '\n');

	if (_commandOrigin == CommandOrigin.Runspace && _commandName.AsSpan().IndexOfAny("\\/:") >= 0)
	if (_commandOrigin == CommandOrigin.Runspace && _commandName.AsSpan().IndexOfAny('\\', '/', ':') >= 0)

	var secondBackslash = moduleCommandName.IndexOf('\\');
	int secondBackslash = moduleCommandName.IndexOf('\\');

Remove static constants #18154

Remove static constants #18154

Uh oh!

Conversation

iSazonov commented Sep 24, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Context

PR Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

xtqqczze commented Sep 26, 2022

Uh oh!

xtqqczze commented Sep 26, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

daxian-dbw left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

xtqqczze Sep 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

xtqqczze commented Sep 29, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

iSazonov commented Oct 4, 2022

Uh oh!

daxian-dbw commented Oct 4, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

iSazonov commented Oct 4, 2022

Uh oh!

iSazonov commented Oct 5, 2022

Uh oh!

iSazonov commented Oct 6, 2022

Uh oh!

ghost commented Oct 13, 2022

Uh oh!

pull-request-quantifier-deprecated bot commented Oct 24, 2022

What can I do to optimize my changes

How to interpret the change counts in git diff output

Uh oh!

daxian-dbw left a comment

Choose a reason for hiding this comment

Uh oh!

iSazonov commented Oct 27, 2022

iSazonov commented Sep 24, 2022 •

edited

Loading

xtqqczze commented Sep 26, 2022 •

edited

Loading

xtqqczze Sep 28, 2022 •

edited

Loading

daxian-dbw commented Oct 4, 2022 •

edited

Loading