Skip to content

A new public API for getting locations of PSModulePath elements #19422

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 9 commits into from
May 23, 2023
Merged

A new public API for getting locations of PSModulePath elements #19422

daxian-dbw merged 9 commits into from
May 23, 2023

Conversation

@JamesWTruher
Copy link
Collaborator

@JamesWTruher JamesWTruher commented Mar 29, 2023 •
edited
Loading

PR Summary

A new public API for retrieving the PSModulePath element for PSHOME, User, and Shared locations.

PR Context

Retrieving the locations for the possible locations for portions of the Module path have been inconsistent. This is a new public api which enables 3rd party tools to have a consistent way to retrieve this information. It should also allow PowerShellGet to simplify code for installations in PowerShell 7.

PR Checklist

@JamesWTruher JamesWTruher changed the title A new public API for getting locations of PSModulePath elements WIP:A new public API for getting locations of PSModulePath elements Mar 29, 2023
@JamesWTruher JamesWTruher changed the title WIP:A new public API for getting locations of PSModulePath elements A new public API for getting locations of PSModulePath elements Apr 12, 2023
@JamesWTruher JamesWTruher requested a review from daxian-dbw April 12, 2023 23:03
SteveL-MSFT
SteveL-MSFT approved these changes Apr 18, 2023
View reviewed changes
Copy link
Member

@SteveL-MSFT SteveL-MSFT left a comment

Choose a reason for hiding this comment

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

One suggestion

TravisEz13
TravisEz13 reviewed Apr 25, 2023
View reviewed changes
test/powershell/engine/Module/assets/PowerShell.TestPackage.3.2.1.nupkg Outdated
Copy link
Member

@TravisEz13 TravisEz13 Apr 25, 2023

Choose a reason for hiding this comment

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

Is this here by mistake?

Copy link
Collaborator Author

@JamesWTruher JamesWTruher Apr 27, 2023

Choose a reason for hiding this comment

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

no - it's used by the tests (line 199)

@daxian-dbw daxian-dbw added WG-Engine core PowerShell engine, interpreter, and runtime Needs-Triage The issue is new and needs to be triaged by a work group. labels May 1, 2023
@StevenBucher98 StevenBucher98 added the PowerShell-Docs needed The PR was reviewed and a PowerShell Docs update is needed label May 8, 2023
SeeminglyScience
SeeminglyScience reviewed May 15, 2023
View reviewed changes
PaulHigin
PaulHigin suggested changes May 15, 2023
View reviewed changes
src/System.Management.Automation/engine/Modules/ModuleIntrinsics.cs Outdated
Copy link
Contributor

@PaulHigin PaulHigin May 15, 2023

Choose a reason for hiding this comment

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

I am wondering if the parameter name should be scope to be consistent with other cmdlets and PowerShellGet.

@ghost ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label May 15, 2023
@JamesWTruher
Implement ModuleIntrinsics.GetPSModulePath api.
22b85be 
 This should provide a consistent way to retrieve the module path element for PSHOME, the user directory, and the shared location.
@JamesWTruher
Improve code comments.
6d49609 
Additional tests and add locations for user and shared tests.
@JamesWTruher
Check platform specific locations for user and shared modules path.
be0d9b0
@JamesWTruher
Add test module for installing to create the needed directories.
eded3fe
@JamesWTruher
Change enum name to PSModulePathType
fcc6ef5 
Require elevation for tests since we're install an allscope module.
@JamesWTruher
Remove checks for directories which may not be present.
316b437
@JamesWTruher
Remove redundant test for api.
d300914
@ghost ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label May 17, 2023
PaulHigin
PaulHigin approved these changes May 17, 2023
View reviewed changes
Copy link
Contributor

@PaulHigin PaulHigin left a comment

Choose a reason for hiding this comment

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

LGTM

@JamesWTruher
Move API tests to it's own describe.
c7e53f4 
Needed because we install a module into shared location.
@pull-request-quantifier-deprecated
Copy link

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

This PR has 43 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       : +43 -0
Percentile : 17.2%

Total files changed: 2

Change summary by file extension:
.cs : +11 -0
.ps1 : +32 -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.

@daxian-dbw daxian-dbw merged commit d9697f0 into PowerShell:master May 23, 2023
@daxian-dbw daxian-dbw added CL-Engine Indicates that a PR should be marked as an engine change in the Change Log and removed Needs-Triage The issue is new and needs to be triaged by a work group. labels May 23, 2023
@sdwheeler
Copy link
Collaborator

sdwheeler commented Jun 1, 2023

@JamesWTruher Can you open a Docs issue for this change?

@JamesWTruher JamesWTruher mentioned this pull request Jun 1, 2023
Closed
3 tasks
@ghost
Copy link

ghost commented Jun 29, 2023

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

Handy links:

@JustinGrote JustinGrote mentioned this pull request Sep 4, 2024
Open
@Jaykul Jaykul mentioned this pull request Sep 11, 2024
Open
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@TravisEz13 TravisEz13 TravisEz13 left review comments

@SeeminglyScience SeeminglyScience SeeminglyScience left review comments

@SteveL-MSFT SteveL-MSFT SteveL-MSFT approved these changes

@daxian-dbw daxian-dbw Awaiting requested review from daxian-dbw

+2 more reviewers

@ThomasNieto ThomasNieto ThomasNieto left review comments

@PaulHigin PaulHigin PaulHigin approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@adityapatwardhan adityapatwardhan

Labels

CL-Engine Indicates that a PR should be marked as an engine change in the Change Log Extra Small PowerShell-Docs needed The PR was reviewed and a PowerShell Docs update is needed WG-Engine core PowerShell engine, interpreter, and runtime

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

10 participants

@JamesWTruher @sdwheeler @daxian-dbw @TravisEz13 @SteveL-MSFT @PaulHigin @SeeminglyScience @ThomasNieto @adityapatwardhan @StevenBucher98