Importing Windows PowerShell modules in PowerShell Core #10973

anmenaga · 2019-11-01T22:31:14Z

PR Summary

Implementation for 'Importing Windows PowerShell modules in PowerShell Core' RFC.

Modules, that are non-compatible with PS Core and were previously generating PSEditionNotSupported error, are now loaded into a background Windows PowerShell process connected to PS Core using a WinPSCompatSession PS remoting session using redirected process streams transport (same one used by PS jobs).
Behaviour can be forced using Import-Module -UseWindowsPowerShell
Module autoload during command discovery is supported
a warning is displayed when a module is loaded into compat Windows PS.
a new telemetry type is added and reported when a module is loaded into compat Windows PS.
operations that do not work on de/serialized objects can be done in WinPSCompatSession remoting session $s = Get-PSSession -Name WinPSCompatSession; Invoke-Command -Session $s -ScriptBlock {Get-WinPSLiveObject | Set-WinPSLiveObject}
new functionality is under PSWinCompat experimental feature.

Example:

PR Context

PR Checklist

ghost · 2019-11-02T02:17:24Z

This PR might impact tooling, because it might be necessary to debug a module imported via compat.

rjmholt · 2019-11-02T04:56:01Z

$s = Get-PSSession -Name WinPSCompatSession; Invoke-Command -Session $s -ScriptBlock {Get-WinPSLiveObject | Set-WinPSLiveObject}

Given that this is to be a builtin feature, the user experience might be better if encapsulated:

Invoke-InWinPSCompatibilitySession { Get-WinPSLiveObject | Set-WinPSLiveObject }

rjmholt · 2019-11-02T04:57:10Z

This PR might impact tooling, because it might be necessary to debug a module imported via compat.

@alexbuzzbee could you expand on this with an example? What scenario are you envisaging here? Also, it might be best to have this discussion in the RFC.

ghost · 2019-11-04T01:50:52Z

Say you have a script module that was written as Windows-specific (because it uses Windows P/Invokes, COM, or Windows-specific .NET APIs), but need to use it in a modern script. A problem is happening inside the Windows-specific module. You need to debug inside it, so the debugging tools need to be able to see and work inside the Windows PowerShell compat session.

Yes, it might be possible to reproduce the issue using a Windows PowerShell script instead, but that would usually be significantly more effort than just debugging the module.

It might be correct that this should go in the RFC; I was just going off the tooling checkboxes and noted that they might not be accurately filled.

anmenaga · 2019-11-04T20:56:58Z

@alexbuzzbee Do these examples fall into scenario that you describe?

Debugging from the same PS process:

Debugging from another PS process:

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

src/System.Management.Automation/engine/remoting/commands/newrunspacecommand.cs

ghost · 2019-11-05T13:11:15Z

@anmenaga All I was trying to point out is that the "I have considered the user experience from a tooling perspective and enumerated concerns in the summary" box should probably be checked instead of "I have considered the user experience from a tooling perspective and don't believe tooling will be impacted."

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

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

src/System.Management.Automation/engine/hostifaces/PowerShellProcessInstance.cs

src/System.Management.Automation/engine/remoting/client/remoterunspaceinfo.cs

…to WinCompat

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

PaulHigin

LGTM

daxian-dbw · 2019-11-06T18:24:55Z

@anmenaga Is this PR ready for review? If so, please remove the WIP: prefix from the title so we can pull in more reviewers.

JamesWTruher

telemetry changes look good

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

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

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

src/System.Management.Automation/engine/hostifaces/PowerShellProcessInstance.cs

src/System.Management.Automation/engine/remoting/commands/CustomShellCommands.cs

test/powershell/Modules/Microsoft.PowerShell.Management/Get-Process.Tests.ps1

iSazonov · 2019-11-14T08:00:14Z

test/powershell/engine/Basic/DefaultCommands.Tests.ps1

 "Alias",        "nsn",                              "New-PSSession",                    $($FullCLR -or $CoreWindows -or $CoreUnix),     "",                     "",                     ""
 "Alias",        "nv",                               "New-Variable",                     $($FullCLR -or $CoreWindows -or $CoreUnix),     "ReadOnly",             "",                     ""
-"Alias",        "nwsn",                             "New-PSWorkflowSession",            $($FullCLR                               ),     "ReadOnly",             "",                     ""
+"Alias",        "nwsn",                             "New-PSWorkflowSession",            $($FullCLR -or $CoreWindows              ),     "",                     "",                     ""


Why do we need the change?

this alias comes from PSWorkflow module which is incompartible with PS Core.
This test just loads all stuff from a hardcoded set of modules and checks against this huge table; PSWorkflow is one of them. With this PR module can actually be successfully loaded on PS Core and the alias shows up, and the test did not expect this.

DefaultCommands.Tests is designed to tracking that is explicitly in PowerShell Core on different platforms and show difference from Windows PowerShell.

If the test failed I guess it is side effect from other tests and just the tests must do right cleanup.

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

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

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

src/System.Management.Automation/engine/hostifaces/PowerShellProcessInstance.cs

src/System.Management.Automation/engine/remoting/commands/newrunspacecommand.cs

src/System.Management.Automation/utils/Telemetry.cs

test/powershell/Modules/Microsoft.PowerShell.Core/CompatiblePSEditions.Module.Tests.ps1

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

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

test/powershell/Modules/Microsoft.PowerShell.Core/Enter-PSHostProcess.Tests.ps1

test/powershell/Modules/Microsoft.PowerShell.Management/Get-Process.Tests.ps1

src/System.Management.Automation/engine/hostifaces/PowerShellProcessInstance.cs

daxian-dbw · 2019-11-16T01:30:20Z

@anmenaga Can you please resolve the conflict, again :)

iSazonov · 2019-11-19T04:20:18Z

Great work @anmenaga !

ghost · 2019-11-21T22:35:56Z

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

Handy links:

Release Notes

Andrew Menagarishvili added 5 commits October 17, 2019 13:20

WinCompat work

35519b1

AnalysisCache Workaround

3f6d922

Using NewProcessConnectionInfo

1527b83

Minor updates

7410fb2

Updates to ImportModuleCommand

0fb4be2

anmenaga added this to the 7.0.0-preview.6 milestone Nov 1, 2019

anmenaga requested review from JamesWTruher, PaulHigin, SteveL-MSFT, daxian-dbw and rjmholt November 1, 2019 22:31

Merge branch 'master' into WinCompat

7541398

SteveL-MSFT assigned daxian-dbw Nov 4, 2019

iSazonov reviewed Nov 5, 2019

View reviewed changes

PaulHigin suggested changes Nov 5, 2019

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 Nov 5, 2019

Andrew Menagarishvili added 3 commits November 5, 2019 13:35

Addressed feedback from Ilya and Paul

dd67412

Merge branch 'WinCompat' of https://github.com/anmenaga/PowerShell in…

af2bd9e

…to WinCompat

fix Codacy issue

1c5cb57

iSazonov reviewed Nov 6, 2019

View reviewed changes

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

PaulHigin approved these changes Nov 6, 2019

View reviewed changes

Workaround for Test-WinRMQuickConfigNeeded

57e06a8

Andrew Menagarishvili added 2 commits November 11, 2019 22:25

Fixed Get-Process.Tests

8efd907

Updated CompatiblePSEditions.Module.Tests

51c045b

anmenaga added the Documentation Needed in this repo Documentation is needed in this repo label Nov 13, 2019

anmenaga changed the title ~~WIP: Importing Windows PowerShell modules in PowerShell Core~~ Importing Windows PowerShell modules in PowerShell Core Nov 13, 2019

JamesWTruher reviewed Nov 13, 2019

View reviewed changes

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

iSazonov reviewed Nov 14, 2019

View reviewed changes

Andrew Menagarishvili added 3 commits November 14, 2019 10:21

Address Jim's feedback

08b2ee0

Address Ilya's feedback

3932249

Addressed Steve's feedback

e1ea2c6

rjmholt reviewed Nov 14, 2019

View reviewed changes

test/powershell/Modules/Microsoft.PowerShell.Core/CompatiblePSEditions.Module.Tests.ps1 Show resolved Hide resolved

Fixed ParameterBinding on non-windows

e6a77f5

SteveL-MSFT requested changes Nov 14, 2019

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 Nov 14, 2019

Andrew Menagarishvili added 2 commits November 14, 2019 15:02

Addressed Rob's feedback

66d9c53

Addressed Steve's feedback

5d74d8a

SteveL-MSFT approved these changes Nov 15, 2019

View reviewed changes

Fixed workingDirectory parameter for WindowsPS

defb2f7

iSazonov reviewed Nov 15, 2019

View reviewed changes

src/System.Management.Automation/engine/hostifaces/PowerShellProcessInstance.cs Show resolved Hide resolved

anmenaga force-pushed the WinCompat branch from cd304cf to defb2f7 Compare November 15, 2019 20:20

Merge branch 'master' into WinCompat

8701cab

Merge branch 'master' into WinCompat

f6649dc

daxian-dbw added the CL-Engine Indicates that a PR should be marked as an engine change in the Change Log label Nov 18, 2019

daxian-dbw merged commit b218e6f into PowerShell:master Nov 18, 2019

iSazonov mentioned this pull request Nov 19, 2019

Test-NetConnection cmdlet is missing from PowerShell Core 6.2.3 release #11111

Closed

MarkIannucci mentioned this pull request Dec 15, 2020

Write-EventLog is deprecated in PowerShell Core 7.1 -- can you suggest a replacement? MicrosoftDocs/PowerShell-Docs#7033

Closed

Importing Windows PowerShell modules in PowerShell Core #10973

Importing Windows PowerShell modules in PowerShell Core #10973

Uh oh!

Conversation

anmenaga commented Nov 1, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Context

PR Checklist

Uh oh!

ghost commented Nov 2, 2019

Uh oh!

rjmholt commented Nov 2, 2019

Uh oh!

rjmholt commented Nov 2, 2019

Uh oh!

ghost commented Nov 4, 2019

Uh oh!

anmenaga commented Nov 4, 2019

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ghost commented Nov 5, 2019

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

PaulHigin left a comment

Choose a reason for hiding this comment

Uh oh!

daxian-dbw commented Nov 6, 2019

Uh oh!

JamesWTruher left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

iSazonov Nov 14, 2019

Choose a reason for hiding this comment

Uh oh!

anmenaga Nov 14, 2019

Choose a reason for hiding this comment

Uh oh!

iSazonov Nov 15, 2019

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

anmenaga commented Nov 1, 2019 •

edited

Loading