Fix the prerequisite check of MSI package #5070

daxian-dbw · 2017-10-09T22:49:32Z

The Fix

Remove the check for Visual C++ Redistributable
Add a precheck for WMF 4.0 on Win7.

pwrshplugin.dll has the following dependencies. All the api-ms-win-crt-* api sets are part of the Universal C Runtime. The plugin DLL doesn't depend on Visual C++ Redistributable.

    KERNEL32.dll
    ole32.dll
    WsmSvc.DLL
    api-ms-win-crt-string-l1-1-0.dll
    api-ms-win-crt-convert-l1-1-0.dll
    api-ms-win-crt-heap-l1-1-0.dll
    api-ms-win-crt-runtime-l1-1-0.dll
    api-ms-win-crt-stdio-l1-1-0.dll
    api-ms-win-crt-filesystem-l1-1-0.dll
    ADVAPI32.dll
    api-ms-win-crt-locale-l1-1-0.dll
    api-ms-win-crt-multibyte-l1-1-0.dll

On Win7, WMF 4.0 or higher version needs to be installed so that the WinRM can support the side-by-side remoting plugin. So I make the WMF 4.0 a prerequisite too.
The way to check PSv4 or above is to check the file version of \windows\system32\pwrshplugin.dll. The file version for in-box PSv4 is 6.3.9600.16384, for WMF 4.0 is 6.3.9600.16406, and for PSv5+ is 10.0.xxx. So we can check the MinVersion of the file pwrshplugin.dll to be 6.3.9600.16383 (means the version needs to be at least 6.3.9600.16384).

I have verified that on 2012R2, Win8.1 and Win7 once Universal C Runtime is installed (it requires a lot of other KB's to be installed) and PSv4 or WMF 4 is available, PowerShell remoting works.

Screenshot Examples

On a machine that doesn't have Universal C Runtime installed:

On Win7 that has Universal C Runtime installed but no WMF 4 or above

SteveL-MSFT · 2017-10-09T23:48:53Z

assets/Product.wxs

      </DirectorySearch>
    </Property>
-    <Condition Message="$(env.ProductName) requires the Universal C Runtime to be installed. You can find a download link to it here: https://github.com/PowerShell/PowerShell/blob/master/docs/installation/windows.md#prerequisites">
+    <Condition Message="$(env.ProductName) requires the Universal C Runtime to be installed to enable remoting over WinRM. You can find a download link to it here: https://github.com/PowerShell/PowerShell/blob/master/docs/installation/windows.md#prerequisites">


That URL is too long. I created this you can use: http://aka.ms/pscore6-prereq

This is much better 😄

SteveL-MSFT · 2017-10-09T23:49:16Z

assets/Product.wxs

    </Property>
-    <Condition Message="$(env.ProductName) requires the Visual Studio 2015 C++ redistributables to be installed. You can find a download link to it here: https://github.com/PowerShell/PowerShell/blob/master/docs/installation/windows.md#prerequisites">
-      <![CDATA[Installed OR VISUAL_CPP_RUNTIME_INSTALLED]]>
+    <Condition Message="$(env.ProductName) requires the Windows Management Framework 4.0 or above to be installed to enable remoting over WinRM. You can find download links here: https://github.com/PowerShell/PowerShell/blob/master/docs/installation/windows.md#prerequisites">


Update this URL as well: http://aka.ms/pscore6-prereq

SteveL-MSFT · 2017-10-09T23:49:56Z

docs/installation/windows.md

  Fully patched (including optional packages), supported systems will already have this installed.
-* Install the [Visual C++ Redistributable](https://www.microsoft.com/download/details.aspx?id=48145) for VS2015.
+* Install the Windows Management Framework (WMF) [4.0](https://www.microsoft.com/en-us/download/details.aspx?id=40855)
+  or above ([5.0](https://www.microsoft.com/en-us/download/details.aspx?id=50395),


change "above" to "newer"

mirichmo · 2017-10-10T01:07:02Z

assets/Product.wxs

    </Property>
-    <Condition Message="$(env.ProductName) requires the Visual Studio 2015 C++ redistributables to be installed. You can find a download link to it here: https://github.com/PowerShell/PowerShell/blob/master/docs/installation/windows.md#prerequisites">
-      <![CDATA[Installed OR VISUAL_CPP_RUNTIME_INSTALLED]]>
+    <Condition Message="$(env.ProductName) requires the Windows Management Framework 4.0 or newer to be installed to enable remoting over WinRM. You can find download links here: http://aka.ms/pscore6-prereq">


I'm wondering if this check should be a notification during installation rather than a requirement. There is a strong desire from a few folks to have PowerShell Core installable on Win 7 SP1 without requiring a WMF installation. The point is to make PowerShell Core usable on those systems without requiring a reboot.

The open questions I have on this topic are:

To what extent does PowerShell Core function on Win 7 SP1 without WMF 4.0+?

Does outgoing remoting function without WMF 4.0 and UCRT?

I think if people want to use powershell regardless of the prerequisites, then the zip package is the way to go -- no precheck. For msi package, it might be better to ensure everything works.

Those two are good open questions.
For UCRT, not sure if WMI/MI.NET would also depend on it.
For WMF 4.0, it's definitely required for making powershell core connectable as server side, but need to see if outgoing remoting needs it on win7.

I'm on the side that the MSI should be comprehensive and the zip for advanced deployments (users knows what they are doing). I think if we get a bunch of customer feedback on the pre-req, we can revisit this.

For UCRT, not sure if WMI/MI.NET would also depend on it.

I tried on Win8.1 and Win2012R2 that don't have UCRT installed, CIM cmdlets seem working fine. So it looks to me that UCRT is only required by pwrshplugin.dll.

OK, thanks for checking. If outgoing remoting works on Win 7 SP1 without WMF 4.0, then my concerns are covered.

Does outgoing remoting function without WMF 4.0 and UCRT?

UCRT is not required for outgoing remoting connection. I'm able to create a session in PowerShell core from a Win81 box without UCRT to another Win81 using the configuration created on the latter Win81.

However, it seems WMF 4 is required for outgoing connection. PowerShell core crashed when I tried to create a session from a Win7 box with PSv2 to a Win7 with WMF 5.1 using the configuration created on the latter Win7:

iSazonov · 2017-10-10T04:11:16Z

Interesting, can an user copy the link we show on error window? Can we do the link clickable?

SteveL-MSFT · 2017-10-10T04:34:04Z

@iSazonov unfortunately, the text the installer displays is not clickable or copyable. Will have to research wix to figure out how to have a custom window that has a clickable link.

daxian-dbw · 2017-10-10T04:38:14Z

@iSazonov it's good that we are now using the short URL "http://aka.ms/pscore6-prereq". It mitigates the problem to some extent.

iSazonov · 2017-10-10T05:55:05Z

Can we use http://www.installsite.org/pages/en/msi/articles/careful-with-that-hyperlink-on-your-msi-dialog/index.htm ?
Another case is to create Open/Cancel buttons.

SteveL-MSFT · 2017-10-10T16:20:31Z

Perhaps we should accept this PR as-is (barring any other concerns) and have a new PR/issue for the custom hyperlink control?

iSazonov · 2017-10-10T17:31:47Z

We can not rush to the next Beta.9 release.

adityapatwardhan · 2017-10-10T21:05:07Z

assets/Product.wxs

      </DirectorySearch>
    </Property>
-    <Condition Message="$(env.ProductName) requires the Universal C Runtime to be installed. You can find a download link to it here: https://github.com/PowerShell/PowerShell/blob/master/docs/installation/windows.md#prerequisites">
+    <Condition Message="$(env.ProductName) requires the Universal C Runtime to be installed to enable remoting over WinRM. You can find a download link to it here: http://aka.ms/pscore6-prereq">


@daxian-dbw You also need to add or modify the link in the installer test here

Thanks, will fix.

adityapatwardhan · 2017-10-10T21:05:23Z

assets/Product.wxs

    </Property>
-    <Condition Message="$(env.ProductName) requires the Visual Studio 2015 C++ redistributables to be installed. You can find a download link to it here: https://github.com/PowerShell/PowerShell/blob/master/docs/installation/windows.md#prerequisites">
-      <![CDATA[Installed OR VISUAL_CPP_RUNTIME_INSTALLED]]>
+    <Condition Message="$(env.ProductName) requires the Windows Management Framework 4.0 or newer to be installed to enable remoting over WinRM. You can find download links here: http://aka.ms/pscore6-prereq">


bergmeister · 2017-10-10T21:13:14Z

assets/Product.wxs

      </DirectorySearch>
    </Property>
-    <Condition Message="$(env.ProductName) requires the Universal C Runtime to be installed. You can find a download link to it here: https://github.com/PowerShell/PowerShell/blob/master/docs/installation/windows.md#prerequisites">
+    <Condition Message="$(env.ProductName) requires the Universal C Runtime to be installed to enable remoting over WinRM. You can find a download link to it here: http://aka.ms/pscore6-prereq">


@daxian-dbw You also need to add or modify the link in the installer test here

bergmeister · 2017-10-10T21:28:00Z

As far as I have seen the message dialog does not allow hyperlinks but the WiX Cookbook gives examples on how to deal with hyperlinks in chapter 11:

One could add a custom action that opens the browser if the installation failed due to the pre-requisite check or embed the hyperlink in a custom WiX exit dialogue in case of failure.

daxian-dbw · 2017-10-10T21:53:01Z

@adityapatwardhan and @bergmeister Thanks for your feedback and I have addressed them. Please take another look.

adityapatwardhan

LGTM

bergmeister · 2017-10-10T22:31:54Z

assets/Product.wxs

    </UI>
    <!-- Prerequisites -->
-    <Condition Message="Supported only on Win8 and above">
+    <Condition Message="Supported only on Win7 and above">


Very minor but should we maybe spell out Win7 completely as Windows 7 and add a full stop?

Yes, we should spell it out completely

bergmeister · 2017-10-10T22:34:41Z

docs/installation/windows.md

  It is available via direct download or Windows Update.
  Fully patched (including optional packages), supported systems will already have this installed.
-* Install the [Visual C++ Redistributable](https://www.microsoft.com/download/details.aspx?id=48145) for VS2015.
+* Install the Windows Management Framework (WMF) [4.0](https://www.microsoft.com/en-us/download/details.aspx?id=40855)


The links should not contain the culture/language specific part en-us

Good catch. Fixed.

bergmeister · 2017-10-10T22:38:13Z

@daxian-dbw Should we also add the new WMF download URLS to the installer tests as their purpose is simply to check that links are still working?

adityapatwardhan · 2017-10-10T22:49:51Z

@daxian-dbw Please use [Feature] in the last git commit message so that the modified test is executed.

daxian-dbw · 2017-10-10T22:58:43Z

@bergmeister new tests are added to verify the WMF download URLs
@adityapatwardhan the latest commit was pushed with [Feature] tag.

bergmeister · 2017-10-10T23:11:45Z

LGTM

daxian-dbw added 4 commits October 6, 2017 16:20

Skip check 'vsruntime140.dll' on Win10

eba1c7d

Make the precheck accurate

6f8d55e

Update windows installation prerequisites

15ededd

Change 'higher' to 'above'

42e4a54

daxian-dbw requested review from SteveL-MSFT, adityapatwardhan and mirichmo October 9, 2017 22:57

daxian-dbw assigned adityapatwardhan Oct 9, 2017

SteveL-MSFT requested changes Oct 9, 2017

View reviewed changes

Address comments

e2e7341

SteveL-MSFT approved these changes Oct 10, 2017

View reviewed changes

mirichmo reviewed Oct 10, 2017

View reviewed changes

adityapatwardhan requested changes Oct 10, 2017

View reviewed changes

bergmeister suggested changes Oct 10, 2017

View reviewed changes

Address more comments

f6e13db

adityapatwardhan approved these changes Oct 10, 2017

View reviewed changes

bergmeister reviewed Oct 10, 2017

View reviewed changes

Address some more comments

391fa5d

[Feature] Update the installer test

36d8370

bergmeister approved these changes Oct 10, 2017

View reviewed changes

adityapatwardhan merged commit f7bab36 into PowerShell:master Oct 10, 2017

daxian-dbw deleted the fixmsi branch October 11, 2017 04:08

Fix the prerequisite check of MSI package #5070

Fix the prerequisite check of MSI package #5070

Uh oh!

Conversation

daxian-dbw commented Oct 9, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

The Fix

Screenshot Examples

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

daxian-dbw Oct 10, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

iSazonov commented Oct 10, 2017

Uh oh!

SteveL-MSFT commented Oct 10, 2017

Uh oh!

daxian-dbw commented Oct 10, 2017

Uh oh!

iSazonov commented Oct 10, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

SteveL-MSFT commented Oct 10, 2017

Uh oh!

iSazonov commented Oct 10, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bergmeister Oct 10, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bergmeister Oct 10, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bergmeister commented Oct 10, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

daxian-dbw commented Oct 10, 2017

Uh oh!

adityapatwardhan left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

daxian-dbw commented Oct 9, 2017 •

edited

Loading

daxian-dbw Oct 10, 2017 •

edited

Loading

iSazonov commented Oct 10, 2017 •

edited

Loading

bergmeister Oct 10, 2017 •

edited

Loading

bergmeister Oct 10, 2017 •

edited

Loading

bergmeister commented Oct 10, 2017 •

edited

Loading

bergmeister commented Oct 10, 2017 •

edited

Loading