Skip to content

Fix Export-PSSession to not throw error when a rooted path is specified for -OutputModule #17671

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 3 commits into from
Jul 13, 2022
Merged

Fix Export-PSSession to not throw error when a rooted path is specified for -OutputModule #17671

daxian-dbw merged 3 commits into from
Jul 13, 2022

Conversation

@daxian-dbw
Copy link
Member

@daxian-dbw daxian-dbw commented Jul 13, 2022

PR Summary

The 7.0.10 release contains a commit for a potential security issue: 38e55e1. Here is the announcement about it: PowerShell/Announcements#31.

This particular change from that commit caused a regression in Azure Function when running Import-Module <module-name> -UseWindowsPowerShell, where the user's module path doesn't exist. That command worked fine with the PowerShell 7.0.9 SDK but started to fail with the PowerShell 7.0.11 SDK.

The root cause is that when Export-PSSession is used by Import-Module -UseWindowsPowerShell, a rooted path is always specified to the -OutputModule parameter, so it doesn't matter whether the user's module path exists or not because it doesn't need it to identify the directory to use.

The fix is to use the specified rooted path directly. Actually, Path.Combine(path1, path2) will return path2 if it's rooted.
The error message is also updated:

image

PR Checklist

@daxian-dbw daxian-dbw requested a review from SteveL-MSFT July 13, 2022 01:04
@daxian-dbw daxian-dbw requested a review from anmenaga July 13, 2022 01:05
@daxian-dbw daxian-dbw added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Jul 13, 2022
PaulHigin
PaulHigin suggested changes Jul 13, 2022
View reviewed changes
@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 Jul 13, 2022
adityapatwardhan
adityapatwardhan reviewed Jul 13, 2022
View reviewed changes
@daxian-dbw @adityapatwardhan
Update src/System.Management.Automation/utils/PathUtils.cs
0610f43 
Co-authored-by: Aditya Patwardhan <adityap@microsoft.com>
@pull-request-quantifier-deprecated
Copy link

pull-request-quantifier-deprecated bot commented Jul 13, 2022

This PR has 26 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       : +15 -11
Percentile : 10.4%

Total files changed: 2

Change summary by file extension:
.resx : +1 -1
.cs : +14 -10

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 detetcted.
  • 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 f9d424d into PowerShell:master Jul 13, 2022
@daxian-dbw daxian-dbw deleted the usewindows branch July 13, 2022 20:32
@iSazonov
Copy link
Collaborator

iSazonov commented Jul 14, 2022 •
edited
Loading

It makes sense for PowerShell Committee to review OutModule parameter. I think the case is the same as #3174 (#11701) - OutModule parameter should be LiteralPath. If so we could simplify CreateModuleDirectory() method.

@Francisco-Gamino Francisco-Gamino mentioned this pull request Jul 14, 2022
Closed
5 tasks
@ghost
Copy link

ghost commented Jul 18, 2022

🎉v7.3.0-preview.6 has been released which incorporates this pull request.:tada:

Handy links:

@adityapatwardhan
Copy link
Member

adityapatwardhan commented Aug 2, 2022

/backport release/v7.2.6

@adityapatwardhan
Copy link
Member

adityapatwardhan commented Aug 2, 2022

/backport to release/v7.0.12

@github-actions
Copy link
Contributor

github-actions bot commented Aug 2, 2022 •
edited by unfurl-links bot
Loading

Started backporting to release/v7.0.12: https://github.com/PowerShell/PowerShell/actions/runs/2784794011

GitHub
PowerShell for every system! Contribute to PowerShell/PowerShell development by creating an account on GitHub.

@adityapatwardhan
Copy link
Member

adityapatwardhan commented Aug 2, 2022

/backport to release/v7.2.6

@github-actions
Copy link
Contributor

github-actions bot commented Aug 2, 2022

@adityapatwardhan backporting to release/v7.0.12 failed, the patch most likely resulted in conflicts:

$ git am --3way --ignore-whitespace --keep-non-patch changes.patch

Applying: Fix Export-PSSession to not throw error when a rooted path is specified for -OutputModule
Applying: Update comment
error: sha1 information is lacking or useless (src/System.Management.Automation/utils/PathUtils.cs).
error: could not build fake ancestor
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0002 Update comment
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".
Error: The process '/usr/bin/git' failed with exit code 128

Please backport manually!

@github-actions
Copy link
Contributor

github-actions bot commented Aug 2, 2022 •
edited by unfurl-links bot
Loading

Started backporting to release/v7.2.6: https://github.com/PowerShell/PowerShell/actions/runs/2784796745

GitHub
PowerShell for every system! Contribute to PowerShell/PowerShell development by creating an account on GitHub.

@github-actions github-actions bot mentioned this pull request Aug 2, 2022
Merged
1 task
@ghost
Copy link

ghost commented Aug 11, 2022

🎉v7.0.12 has been released which incorporates this pull request.:tada:

Handy links:

@ghost
Copy link

ghost commented Aug 11, 2022

🎉v7.2.6 has been released which incorporates this pull request.:tada:

Handy links:

@TravisEz13 TravisEz13 mentioned this pull request Sep 30, 2022
Merged
22 tasks
@daxian-dbw daxian-dbw mentioned this pull request May 8, 2023
Closed
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@TravisEz13 TravisEz13 TravisEz13 approved these changes

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

@adityapatwardhan adityapatwardhan adityapatwardhan approved these changes

@anmenaga anmenaga Awaiting requested review from anmenaga

+1 more reviewer

@PaulHigin PaulHigin PaulHigin approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@daxian-dbw daxian-dbw

Labels

Backport-7.0.x-Done Backport-7.2.x-Done CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log Extra Small

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@daxian-dbw @iSazonov @adityapatwardhan @TravisEz13 @SteveL-MSFT @PaulHigin