From d7dd4b5dd20a76579f0df7e5abf54ebf9ae663f2 Mon Sep 17 00:00:00 2001
From: Travis Plunk <travis.plunk@microsoft.com>
Date: Thu, 28 Feb 2019 14:05:27 -0800
Subject: [PATCH] Fix MSI Upgrade failure for preview builds (#9013)

---
 assets/Product.wxs             | 32 +++++++++---------
 tools/packaging/packaging.psm1 | 61 ++++++++++------------------------
 2 files changed, 34 insertions(+), 59 deletions(-)

diff --git a/assets/Product.wxs b/assets/Product.wxs
index 8d462fa834..0f21e71bec 100644
--- a/assets/Product.wxs
+++ b/assets/Product.wxs
@@ -25,12 +25,12 @@
   <?define ExplorerContextSubMenuDialogText = "Open &here"?>
   <?define ExplorerContextSubMenuElevatedDialogText = "Open here as &Administrator"?>
   <!-- The ProductCode is Product Id and needs to be unique for every PowerShell version to allow SxS install: http://wixtoolset.org/documentation/manual/v3/xsd/wix/product.html -->
-  <Product 
-    Id="$(var.ProductCode)" 
-    Name="PowerShell $(var.SimpleProductVersion)-$(sys.BUILDARCH)" 
-    Language="1033" 
-    Version="$(var.ProductVersion)" 
-    Manufacturer="Microsoft Corporation" 
+  <Product
+    Id="$(var.ProductCode)"
+    Name="PowerShell $(var.SimpleProductVersion)-$(sys.BUILDARCH)"
+    Language="1033"
+    Version="$(var.ProductVersion)"
+    Manufacturer="Microsoft Corporation"
     UpgradeCode="$(var.UpgradeCode)">
     <!-- Properties About The Package -->
     <Package Id="*" Keywords="Installer" Platform="$(sys.BUILDARCH)" InstallerVersion="200" Compressed="yes" InstallScope="perMachine" Description="PowerShell package" Comments="PowerShell for every system" />
@@ -48,6 +48,8 @@
     <Property Id="WIXUI_EXITDIALOGOPTIONALCHECKBOXTEXT" Value="Open $(env.ProductName)" />
     <!-- Default value of Checkbox of starting PowerShell after installation -->
     <Property Id="WixShellExecTarget" Value="[$(var.ProductDirectoryName)]pwsh.exe"/>
+    <!-- This changes the default setting from "reinstall if the file is a newer version" to "reinstall if the file is a different version" -->
+    <Property Id="REINSTALLMODE" Value="dmus"/>
     <CustomAction Id="LaunchApplication" BinaryKey="WixCA" DllEntry="WixShellExec" Impersonate="yes" />
 
     <SetProperty Id="RegisterManifest"
@@ -154,7 +156,7 @@
               <CreateFolder/>
             </Component>
             <Component Id="RegistryEntries" Guid="{402e52f7-baf8-489d-af21-f756a6ca3530}">
-                <!-- create key for easy detection of a particular version of a powershell core package 
+                <!-- create key for easy detection of a particular version of a powershell core package
                      The upgrade code is used in the key because it will change when we allow SxS       -->
                 <RegistryKey Root="HKLM" Key="Software\Microsoft\PowerShellCore\InstalledVersions\$(var.UpgradeCode)" ForceCreateOnInstall="yes" ForceDeleteOnUninstall="yes">
                     <RegistryValue Type="string" Value="$(var.ProductSemanticVersion)" Name="SemanticVersion"/>
@@ -227,9 +229,9 @@
       <Directory Id="ProgramMenuFolder">
         <Directory Id="ApplicationProgramsFolder" Name="$(var.ProductName)">
           <Component Id="ApplicationProgramsMenuShortcut" Guid="*">
-            <Shortcut Id="PowerShell_ProgramsMenuShortcut" 
-                      Name="$(var.ProductSimpleVersionWithNameAndOptionalArchitecture)" 
-                      Description="$(var.ProductSimpleVersionWithNameAndOptionalArchitecture)" 
+            <Shortcut Id="PowerShell_ProgramsMenuShortcut"
+                      Name="$(var.ProductSimpleVersionWithNameAndOptionalArchitecture)"
+                      Description="$(var.ProductSimpleVersionWithNameAndOptionalArchitecture)"
                       Target="[$(var.ProductDirectoryName)]pwsh.exe"
                       Arguments="-WorkingDirectory ~"
                       Icon = "PowerShellExe.ico" />
@@ -265,7 +267,7 @@
         <Text><![CDATA[<a href="https://github.com/PowerShell/PowerShell/blob/master/ThirdPartyNotices.txt">Please review the ThirdPartyNotices.txt</a>]]></Text>
       </Control>
       <!-- divider and bottom buttons -->
-      <Control Id="BottomLine" Type="Line" X="0" Y="234" Width="370" Height="0" TabSkip="yes"/>    
+      <Control Id="BottomLine" Type="Line" X="0" Y="234" Width="370" Height="0" TabSkip="yes"/>
       <Control Id="Back" Type="PushButton" X="180" Y="243" Width="56" Height="17" Text="!(loc.WixUIBack)"/>
       <Control Id="Next" Type="PushButton" X="236" Y="243" Width="56" Height="17" Cancel="yes" Default="yes" Text="!(loc.WixUINext)"/>
       <Control Id="Cancel" Type="PushButton" X="304" Y="243" Width="56" Height="17" Cancel="yes" Text="!(loc.WixUICancel)">
@@ -277,7 +279,7 @@
 
 <!-- Customized version of WixUI_InstallDir, which is necessary to add custom dialogs. https://github.com/wixtoolset/wix3/blob/master/src/ext/UIExtension/wixlib/WixUI_InstallDir.wxs -->
 <Fragment>
-  <UI Id="CustomWixUI_InstallDir">        
+  <UI Id="CustomWixUI_InstallDir">
       <!--
       First-time install dialog sequence:
       - WixUI_WelcomeDlg
@@ -313,8 +315,8 @@
       <DialogRef Id="ResumeDlg" />
       <DialogRef Id="UserExit" />
       <DialogRef Id="ExplorerContextMenuDialog" />
-      
-      
+
+
       <Publish Dialog="BrowseDlg" Control="OK" Event="DoAction" Value="WixUIValidatePath" Order="3">1</Publish>
       <Publish Dialog="BrowseDlg" Control="OK" Event="SpawnDialog" Value="InvalidDirDlg" Order="4"><![CDATA[NOT WIXUI_DONTVALIDATEPATH AND WIXUI_INSTALLDIR_VALID<>"1"]]></Publish>
 
@@ -332,7 +334,7 @@
       <Publish Dialog="InstallDirDlg" Control="Next" Event="NewDialog" Value="ExplorerContextMenuDialog" Order="5">1</Publish>
       <Publish Dialog="InstallDirDlg" Control="ChangeFolder" Property="_BrowseProperty" Value="[WIXUI_INSTALLDIR]" Order="1">1</Publish>
       <Publish Dialog="InstallDirDlg" Control="ChangeFolder" Event="SpawnDialog" Value="BrowseDlg" Order="2">1</Publish>
-      
+
       <Publish Dialog="VerifyReadyDlg" Control="Back" Event="NewDialog" Value="ExplorerContextMenuDialog" Order="1">NOT Installed</Publish>
       <Publish Dialog="VerifyReadyDlg" Control="Back" Event="NewDialog" Value="MaintenanceTypeDlg" Order="2">Installed AND NOT PATCH</Publish>
       <Publish Dialog="VerifyReadyDlg" Control="Back" Event="NewDialog" Value="WelcomeDlg" Order="2">Installed AND PATCH</Publish>
diff --git a/tools/packaging/packaging.psm1 b/tools/packaging/packaging.psm1
index c29ecb93fd..475c15abc7 100644
--- a/tools/packaging/packaging.psm1
+++ b/tools/packaging/packaging.psm1
@@ -2646,7 +2646,6 @@ function New-MSIPackage
     if ($isPreview)
     {
         $simpleProductVersion += '-preview'
-        $FilesWxsPath = New-PreviewFileWxs -FilesWxsPath $FilesWxsPath
     }
 
     $ProductVersion = Get-PackageVersionAsMajorMinorBuildRevision -Version $ProductVersion
@@ -2698,14 +2697,7 @@ function New-MSIPackage
 
     $wixFragmentPath = Join-Path $env:Temp "Fragment.wxs"
     $wixObjProductPath = Join-Path $env:Temp "Product.wixobj"
-    if ($isPreview)
-    {
-        $wixObjFragmentPath = Join-Path $env:Temp "files-preview.wixobj"
-    }
-    else
-    {
-        $wixObjFragmentPath = Join-Path $env:Temp "files.wixobj"
-    }
+    $wixObjFragmentPath = Join-Path $env:Temp "files.wixobj"
 
     # cleanup any garbage on the system
     Remove-Item -ErrorAction SilentlyContinue $wixFragmentPath -Force
@@ -2726,8 +2718,24 @@ function New-MSIPackage
 
     Write-Log "verifying no new files have been added or removed..."
     Start-NativeExecution -VerboseOutputOnError { & $wixPaths.wixHeatExePath dir  $ProductSourcePath -dr  $productDirectoryName -cg $productDirectoryName -gg -sfrag -srd -scom -sreg -out $wixFragmentPath -var env.ProductSourcePath -v}
+
+    # We are verifying that the generated $wixFragmentPath and $FilesWxsPath are functionally the same
     Test-FileWxs -FilesWxsPath $FilesWxsPath -HeatFilesWxsPath $wixFragmentPath
 
+    if ($isPreview)
+    {
+        # Now that we know that the two are functionally the same,
+        # We only need to use $FilesWxsPath for release we want to be able to Path
+        # and two releases shouldn't have the same identifiers,
+        # so we use the generated one for preview
+        $FilesWxsPath = $wixFragmentPath
+
+        $wixObjFragmentPath = Join-Path $env:Temp "Fragment.wixobj"
+
+        # cleanup any garbage on the system
+        Remove-Item -ErrorAction SilentlyContinue $wixObjFragmentPath -Force
+    }
+
     Write-Log "running candle..."
     Start-NativeExecution -VerboseOutputOnError { & $wixPaths.wixCandleExePath  "$ProductWxsPath"  "$FilesWxsPath" -out (Join-Path "$env:Temp" "\\") -ext WixUIExtension -ext WixUtilExtension -arch $ProductTargetArchitecture -v}
 
@@ -2739,11 +2747,6 @@ function New-MSIPackage
     Remove-Item -ErrorAction SilentlyContinue $wixFragmentPath -Force
     Remove-Item -ErrorAction SilentlyContinue $wixObjProductPath -Force
     Remove-Item -ErrorAction SilentlyContinue $wixObjFragmentPath -Force
-    if ($isPreview)
-    {
-        # remove the temporary generated files.wxs for preview builds
-        Remove-Item -ErrorAction SilentlyContinue $FilesWxsPath -Force
-    }
 
     if ((Test-Path $msiLocationPath) -and (Test-Path $msiPdbLocationPath))
     {
@@ -2765,36 +2768,6 @@ function New-MSIPackage
     }
 }
 
-# generate a files.wxs for preview builds
-# so that the component ids are different than the stable builds
-# the file is created in the temp folder
-function New-PreviewFileWxs
-{
-    param
-    (
-        # File describing the MSI file components from the asset folder
-        [ValidateNotNullOrEmpty()]
-        [ValidateScript( {Test-Path $_})]
-        [string] $FilesWxsPath = "$RepoRoot\assets\Files.wxs"
-    )
-
-    Write-Verbose "Generating new component Ids for Files-Preview.wxs" -Verbose
-    [xml] $filesAssetXml = Get-Content -Raw -Path $FilesWxsPath
-    foreach($component in $filesAssetXml.GetElementsByTagName('Component'))
-    {
-        $component.Id = $component.Id + "_Preview"
-    }
-
-    foreach($componentRef in $filesAssetXml.GetElementsByTagName('ComponentRef'))
-    {
-        $componentRef.Id = $componentRef.Id + "_Preview"
-    }
-
-    $previewFilesWxsPath = Join-Path ([System.IO.Path]::GetTempPath()) "Files-Preview.wxs"
-    $filesAssetXml.Save($previewFilesWxsPath)
-    $previewFilesWxsPath
-}
-
 # verify no files have been added or removed
 # if so, write an error with details
 function Test-FileWxs