10BC0 Remove PathSearchTrimEnd by iSazonov · Pull Request #18166 · PowerShell/PowerShell · GitHub
[go: up one dir, main page]
Skip to content

Remove PathSearchTrimEnd #18166

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
Closed
iSazonov wants to merge 1 commit into from
Closed

Remove PathSearchTrimEnd #18166

iSazonov wants to merge 1 commit into from

Conversation

@iSazonov
Copy link
Collaborator
@iSazonov iSazonov commented Sep 27, 2022 •
edited
Loading

PR Summary

This is moved from #18154.

PathSearchTrimEnd is removed based on dotnet/runtime#76122 (comment)
For ex., now we don't remove trail spaces that are valid in file names on Windows.
On Linux it was even more incorrect.

PR Context

PR Checklist

@iSazonov iSazonov added the CL-CodeCleanup Indicates that a PR should be marked as a Code Cleanup change in the Change Log label Sep 27, 2022
@pull-request-quantifier-deprecated
Copy link
pull-request-quantifier-deprecated bot commented Sep 27, 2022

This PR has 6 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 -5
Percentile : 2.4%

Total files changed: 2

Change summary by file extension:
.cs : +1 -5

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.

xtqqczze
xtqqczze reviewed Sep 27, 2022
View reviewed changes
src/System.Management.Automation/engine/CommandSearcher.cs
/// The command name to search for.
/// </summary>
private string _commandName;
private readonly string _commandName;
Copy link
Contributor
@xtqqczze xtqqczze Sep 27, 2022

Choose a reason for hiding this comment

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

For reviewers: this fixes a violation IDE0044: Add readonly modifier, enabled in #13880.

@daxian-dbw daxian-dbw mentioned this pull request Sep 29, 2022
Merged
22 tasks
SteveL-MSFT
SteveL-MSFT requested changes Oct 3, 2022
View reviewed changes
src/System.Management.Automation/engine/CommandSearcher.cs

if (!string.IsNullOrEmpty(fileName))
{
fileName = fileName.TrimEnd(Utils.Separators.PathSearchTrimEnd);
Copy link
Member
@SteveL-MSFT SteveL-MSFT Oct 3, 2022

Choose a reason for hiding this comment

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

Seems like we should have a test for this? With this we should now be able to call executables that have trailing whitespace? (although seems like a bad practice)

Copy link
Collaborator Author
@iSazonov iSazonov Oct 3, 2022

Choose a reason for hiding this comment

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

Test what? In common, it is impossible to know what is OS and file system limitations. As .Net team concluded, the best thing we can do is to defer checks to OS and file system.

With this we should now be able to call executables that have trailing whitespace? (although seems like a bad practice)

I don't see any changes in behavior on Windows in my manual tests.
I'd expect that now we can run a file with trailing spaces.

@ghost 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 Oct 3, 2022
daxian-dbw
daxian-dbw requested changes Oct 3, 2022
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.

This is a breaking change: today, I can run & 'pwsh ' (trailing space in the command name). With this change, it won't work anymore.

I don't think we should change anything in the command searching code. If our FileSystemProvider cannot find a file with trailing spaces in its name as it should, then make the changes there, but not the command discovery code.

@ghost ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Oct 3, 2022
@iSazonov
Copy link
Collaborator Author
iSazonov commented Oct 4, 2022

This is a breaking change: today, I can run & 'pwsh ' (trailing space in the command name). With this change, it won't work anymore.

I don't think we should change anything in the command searching code. If our FileSystemProvider cannot find a file with trailing spaces in its name as it should, then make the changes there, but not the command discovery code.

This is as strange as if we cut the end H in pwsh and still pws would run as pwsh.

This rather indicates that there is a bug in the way we run applications and not in the search or FileSystemProvider.

@iSazonov iSazonov closed this Oct 4, 2022
@ghost ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Oct 4, 2022
@iSazonov iSazonov deleted the remove-pathtrimend branch October 4, 2022 04:45
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 requested changes

@SteveL-MSFT SteveL-MSFT SteveL-MSFT requested changes

+1 more reviewer

@xtqqczze xtqqczze xtqqczze left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@daxian-dbw daxian-dbw

Labels

CL-CodeCleanup Indicates that a PR should be marked as a Code Cleanup change in the Change Log Extra Small

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@iSazonov @daxian-dbw @SteveL-MSFT @xtqqczze
0