Fix constructing PSModulePath if a sub-path has trailing separator #13147

SteveL-MSFT · 2020-07-10T01:20:27Z

PR Summary

When constructing PSModulePath, the code checks if one of user path, shared path, or $PSHome path is already part of PSModulePath. The code that does the check trims whitespace and trailing path separator. So if one of those paths match, but actually has whitespace or trailing separator, then the index doesn't take that into account and subsequent paths are inserted in the wrong location creating an invalid path.

The fix is if one of those paths are found, then find the next index of the path separator and insert at that index. If there is no path separator after that index, then it just gets appended to the end.

Spent too much time trying to add a test. The repro requires changing the system environment variable for PSModulePath and a new process to be started so that it's not inherited from an existing PowerShell process. Validated manually.

PR Context

Fix #13025

PR Checklist

rjmholt · 2020-07-10T16:04:01Z

@SteveL-MSFT are you planning on re-adding a new test?

src/System.Management.Automation/engine/Modules/ModuleIntrinsics.cs

SteveL-MSFT · 2020-07-10T21:34:58Z

I might have to use a test hook to be able to add a test, need to think more about this.

iSazonov · 2020-07-23T11:43:31Z

I suggest add xUnit test. It is more fast and simple.

iSazonov

Downloaded artifact works well.

test/powershell/engine/Module/ModulePath.Tests.ps1

rjmholt · 2020-07-23T22:40:43Z

I'm hoping @daxian-dbw will also have a chance to review this this week

rjmholt · 2020-07-27T16:58:38Z

@PoshChan please remind me in 10 days

rjmholt · 2020-08-04T22:10:01Z

@daxian-dbw please take a moment to review this if you have time

src/System.Management.Automation/engine/Modules/ModuleIntrinsics.cs

ghost · 2020-09-16T23:00:11Z

This pull request has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 15 days. It will be closed if no further activity occurs within 10 days of this comment.

ghost · 2020-10-10T02:00:11Z

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

ghost · 2021-11-10T02:00:58Z

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

TravisEz13 · 2023-05-01T21:51:02Z

@SteveL-MSFT If this is still needed, can you resolve the conflicts

pull-request-quantifier-deprecated · 2023-05-02T19:04:52Z

This PR has 29 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       : +19 -10
Percentile : 11.6%

Total files changed: 2

Change summary by file extension:
.cs : +10 -10
.ps1 : +9 -0

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 · 2023-06-29T22:05:13Z

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

Handy links:

Release Notes

SteveL-MSFT requested a review from rjmholt July 10, 2020 01:20

ghost assigned rjmholt Jul 10, 2020

rjmholt requested review from daxian-dbw and iSazonov July 10, 2020 16:04

rjmholt reviewed Jul 10, 2020

View reviewed changes

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

rjmholt marked this pull request as draft July 10, 2020 22:12

ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jul 14, 2020

ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jul 23, 2020

SteveL-MSFT force-pushed the concat-path branch from e3f1d85 to 080e13e Compare July 23, 2020 04:49

SteveL-MSFT force-pushed the concat-path branch from 9b56e3b to 8114795 Compare July 23, 2020 13:27

iSazonov approved these changes Jul 23, 2020

View reviewed changes

SteveL-MSFT marked this pull request as ready for review July 23, 2020 14:07

rjmholt reviewed Jul 23, 2020

View reviewed changes

test/powershell/engine/Module/ModulePath.Tests.ps1 Outdated Show resolved Hide resolved

rjmholt approved these changes Jul 23, 2020

View reviewed changes

iSazonov added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Jul 24, 2020

rjmholt added the Review - Needed The PR is being reviewed label Jul 28, 2020

daxian-dbw reviewed Aug 4, 2020

View reviewed changes

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

rjmholt added Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept and removed Review - Needed The PR is being reviewed labels Sep 1, 2020

ghost added the Stale label Sep 16, 2020

ghost closed this Sep 27, 2020

SteveL-MSFT reopened this Oct 2, 2020

ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Oct 2, 2020

ghost removed the Stale label Oct 2, 2020

ghost added the Review - Needed The PR is being reviewed label Oct 10, 2020

SteveL-MSFT force-pushed the concat-path branch from 71f774e to f745b18 Compare July 1, 2021 20:30

daxian-dbw assigned TravisEz13 and unassigned rjmholt Nov 3, 2021

ghost removed the Review - Needed The PR is being reviewed label Nov 3, 2021

ghost added the Review - Needed The PR is being reviewed label Nov 10, 2021

ghost removed the Review - Needed The PR is being reviewed label May 1, 2023

SteveL-MSFT added 6 commits May 2, 2023 12:03

Fix constructing PSModulePath if a sub-path has trailing separator

ee4e3f2

skip test on Linux

c5e4841

Removed test as the system env var needs to be modified to repro

6af8439

Add test

00e1410

Fix test by comparing against incorrectly created path

c3cc9de

Update test to be cross platform

183114a

SteveL-MSFT force-pushed the concat-path branch from f745b18 to 183114a Compare May 2, 2023 19:03

pull-request-quantifier-deprecated bot added the Extra Small label May 2, 2023

TravisEz13 merged commit 8135167 into PowerShell:master May 2, 2023

ghost mentioned this pull request Jun 29, 2023

Concatenated PSModulePath values for PS7 module paths #13025

Closed

Fix constructing PSModulePath if a sub-path has trailing separator #13147

Fix constructing PSModulePath if a sub-path has trailing separator #13147

Uh oh!

Conversation

SteveL-MSFT commented Jul 10, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Context

PR Checklist

Uh oh!

rjmholt commented Jul 10, 2020

Uh oh!

Uh oh!

SteveL-MSFT commented Jul 10, 2020

Uh oh!

iSazonov commented Jul 23, 2020

Uh oh!

iSazonov left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

rjmholt commented Jul 23, 2020

Uh oh!

rjmholt commented Jul 27, 2020

Uh oh!

rjmholt commented Aug 4, 2020

Uh oh!

Uh oh!

ghost commented Sep 16, 2020

Uh oh!

ghost commented Oct 10, 2020

Uh oh!

ghost commented Nov 10, 2021

Uh oh!

TravisEz13 commented May 1, 2023

Uh oh!

pull-request-quantifier-deprecated bot commented May 2, 2023

What can I do to optimize my changes

How to interpret the change counts in git diff output

Uh oh!

ghost commented Jun 29, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

SteveL-MSFT commented Jul 10, 2020 •

edited

Loading