[WiX 5] Migrate SDK from v3 to v5

.editorconfig

@@ -475,6 +475,10 @@ indent_brace_style = Allman
 [*.{csproj,vbproj,vcxproj,vcxproj.filters,proj,nativeproj,locproj}]
 indent_size = 2
 
+# WiX files
+[*.{wixproj,wxs,wxi,wxl,thm}]
+indent_size = 2
+
 [*.{csproj,vbproj,proj,nativeproj,locproj}]
 charset = utf-8-bom
 

Directory.Packages.props

@@ -79,6 +79,11 @@
     <PackageVersion Include="Microsoft.Web.Xdt" Version="$(MicrosoftWebXdtPackageVersion)" />
     <PackageVersion Include="Microsoft.Win32.SystemEvents" Version="$(MicrosoftWin32SystemEventsPackageVersion)" />
     <PackageVersion Include="Microsoft.Windows.CsWin32" Version="$(MicrosoftWindowsCsWin32PackageVersion)" />
+    <PackageVersion Include="Microsoft.WixToolset.Bal.wixext" Version="$(MicrosoftWixToolsetVersion)" />
+    <PackageVersion Include="Microsoft.WixToolset.Dependency.wixext" Version="$(MicrosoftWixToolsetVersion)" />
+    <PackageVersion Include="Microsoft.WixToolset.Heat" Version="$(MicrosoftWixToolsetVersion)" />
+    <PackageVersion Include="Microsoft.WixToolset.Util.wixext" Version="$(MicrosoftWixToolsetVersion)" />
+    <PackageVersion Include="Microsoft.WixToolset.UI.wixext" Version="$(MicrosoftWixToolsetVersion)" />
     <PackageVersion Include="MSBuild.StructuredLogger" Version="2.2.386" />
     <PackageVersion Include="Moq" Version="$(MoqPackageVersion)" />
     <PackageVersion Include="NETStandard.Library.NETFramework" Version="$(NETStandardLibraryNETFrameworkVersion)" />

build.cmd

@@ -1,12 +1,16 @@
 @echo off
 
+setlocal
+
 echo %* | findstr /C:"-pack" >nul
 if %errorlevel%==0 (
-    set SkipBuildingInstallers=
+    set skipFlags="/p:SkipUsingCrossgen=false /p:SkipBuildingInstallers=false"
 ) else (
     REM skip crossgen for inner-loop builds to save a ton of time
     set skipFlags="/p:SkipUsingCrossgen=true /p:SkipBuildingInstallers=true"
 )
 set DOTNET_SYSTEM_NET_SECURITY_NOREVOCATIONCHECKBYDEFAULT=true
 powershell -NoLogo -NoProfile -ExecutionPolicy ByPass -command "& """%~dp0eng\common\build.ps1""" -restore -build -msbuildEngine dotnet %skipFlags% %*"
+
+endlocal
 exit /b %ErrorLevel%

global.json

@@ -24,6 +24,7 @@
     "Microsoft.DotNet.Arcade.Sdk": "10.0.0-beta.25373.106",
     "Microsoft.DotNet.Helix.Sdk": "10.0.0-beta.25373.106",
     "Microsoft.Build.NoTargets": "3.7.0",
-    "Microsoft.Build.Traversal": "3.4.0"
+    "Microsoft.Build.Traversal": "3.4.0",
+    "Microsoft.WixToolset.Sdk": "5.0.2-dotnet.2737382"
   }
 }

src/Layout/finalizer/Program.cs

@@ -5,14 +5,15 @@
 using Microsoft.Win32;
 using Microsoft.Win32.Msi;
 
-if (args.Length < 3)
+if (args.Length < 4)
 {
     return (int)Error.INVALID_COMMAND_LINE;
 }
 
 string logPath = args[0];
 string sdkVersion = args[1];
 string platform = args[2];
+int bundleAction = Convert.ToInt32(args[3]);
 
 using StreamWriter logStream = new StreamWriter(logPath);
 
@@ -21,8 +22,16 @@
 Logger.Log($"{nameof(logPath)}: {logPath}");
 Logger.Log($"{nameof(sdkVersion)}: {sdkVersion}");
 Logger.Log($"{nameof(platform)}: {platform}");
+Logger.Log($"{nameof(bundleAction)}: {bundleAction}");
 int exitCode = (int)Error.SUCCESS;
 
+// The finalizer should only run when the parent bundle is being removed if WixBundleAction is set to BOOTSTRAPPER_ACTION_UNINSTALL
+// or BOOTSTRAPPER_ACTION_UNSAFE_UNINSTALL.
+if (bundleAction < 3 || bundleAction > 4)
+{
+    return exitCode;
+}
+
 try
 {
     // Step 1: Parse and format SDK feature band version

src/Layout/pkg/dotnet-sdk.proj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.Build.NoTargets">
+<Project Sdk="Microsoft.Build.NoTargets">
 
   <PropertyGroup>
     <BuildSdkRpm Condition="'$(BuildSdkRpm)' == '' and '$(IsRPMBasedDistro)' == 'true'">true</BuildSdkRpm>
@@ -33,6 +33,22 @@
 
   <ItemGroup>
     <ProjectReference Include="..\redist\redist.csproj" ReferenceOutputAssembly="false" />
+  </ItemGroup>
+
+  <ItemGroup Condition="'$(OS)' == 'Windows_NT'">
+    <!-- These project references ensure that package references for WiX extensions are correctly restored. The Idle target is a no-op as the
+         projects are built later when computed properties are available. These properties do not exist when projects are evaluated. -->
+    <ProjectReference Include="windows\msis\placeholder\placeholder.wixproj" ReferenceOutputAssembly="false" SkipGetTargetFrameworkProperties="true"
+                      Targets="Idle" />
+    <ProjectReference Include="windows\msis\templates\templates.wixproj" ReferenceOutputAssembly="false" SkipGetTargetFrameworkProperties="true"
+                      Targets="Idle" />
+    <ProjectReference Include="windows\msis\toolset\toolset.wixproj" ReferenceOutputAssembly="false" SkipGetTargetFrameworkProperties="true"
+                      Targets="Idle" />
+    <ProjectReference Include="windows\bundles\sdk\bundle.wixproj" ReferenceOutputAssembly="false" SkipGetTargetFrameworkProperties="true"
+                      Targets="Idle" />
+  </ItemGroup>
+
+  <ItemGroup>
     <PackageReference Include="Microsoft.DotNet.Build.Tasks.Installers" />
   </ItemGroup>
 

src/Layout/pkg/windows/Directory.Build.props

@@ -0,0 +1,28 @@
+<!-- Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the MIT license. See License.txt in the project root for full license information. -->
+<Project>
+  <Import Project="$([MSBuild]::GetPathOfFileAbove('Directory.Build.props', '$(MSBuildThisFileDirectory)../'))" />
+
+  <PropertyGroup>
+    <!-- Currently, WiX only supports 'full' for the -pdbType option. This affects both bundle and package projects. -->
+    <DebugType>full</DebugType>
+
+    <!-- .wixproj defaults to AnyCPU which eventually defaults to x86. InstallerPlatform determines the bitness of
+         the installer and should always match for MSIs. For bundles, we have to remain on x86. -->
+    <InstallerPlatform Condition="'$(InstallerPlatform)' == ''">$(TargetArchitecture)</InstallerPlatform>
+    <Platform>$(InstallerPlatform)</Platform>
+    <PlatformName>$(InstallerPlatform)</PlatformName>
+  </PropertyGroup>
+
+  <PropertyGroup Condition="'$(MSBuildProjectExtension)' == '.wixproj'">
+    <DefineConstants>$(DefineConstants);SdkFeatureBandVersion=$(CliProductBandVersion)00</DefineConstants>
+    <DefineConstants>$(DefineConstants);ProductLanguage=1033</DefineConstants>
+    <DefineConstants>$(DefineConstants);Manufacturer=Microsoft Corporation</DefineConstants>
+    <DefineConstants>$(DefineConstants);MajorVersion=$(VersionMajor)</DefineConstants>
+    <DefineConstants>$(DefineConstants);MinorVersion=$(VersionMinor)</DefineConstants>
+    <DefineConstants>$(DefineConstants);TargetArchitecture=$(TargetArchitecture)</DefineConstants>
+
+    <!-- Technically we don't support .NET on any version of Windows where the version of Windows Installer is less than 5.0. -->
+    <DefineConstants Condition="'$(InstallerPlatform)' != 'arm64'">$(DefineConstants);InstallerVersion=200</DefineConstants>
+    <DefineConstants Condition="'$(InstallerPlatform)' == 'arm64'">$(DefineConstants);InstallerVersion=500</DefineConstants>
+  </PropertyGroup>
+</Project>

src/Layout/pkg/windows/Directory.Build.targets

@@ -0,0 +1,73 @@
+<!-- Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the MIT license. See License.txt in the project root for full license information. -->
+<Project>
+  <Import Project="$([MSBuild]::GetPathOfFileAbove('Directory.Build.targets', '$(MSBuildThisFileDirectory)../'))" />
+
+  <PropertyGroup Condition="'$(MSBuildProjectExtension)' == '.wixproj'">
+    <!-- Example: Microsoft .NET SDK 10.0.100 -->
+    <DefineConstants>$(DefineConstants);SdkBrandName=$(SdkBrandName)</DefineConstants>
+    <!-- Example: Microsoft .NET SDK 10.0.100 (x64) -->
+    <DefineConstants>$(DefineConstants);SdkPlatformBrandName=$(SdkBrandName) ($(TargetArchitecture))</DefineConstants>
+
+    <!-- NativeMachine values match the expected values for image file machine constants
+         https://docs.microsoft.com/en-us/windows/win32/sysinfo/image-file-machine-constants -->
+    <DefineConstants>$(DefineConstants);NativeMachine_x86=332</DefineConstants>
+    <DefineConstants>$(DefineConstants);NativeMachine_x64=34404</DefineConstants>
+    <DefineConstants>$(DefineConstants);NativeMachine_arm64=43620</DefineConstants>
+
+    <!-- This is the full semenatic version of the SDK. -->
+    <DefineConstants>$(DefineConstants);Version=$(Version)</DefineConstants>
+    <!-- BundleVersion is used by MSIs when generating provider keys, but ProductVersion is never used when generating bundles. -->
+    <DefineConstants Condition="'$(ProductVersion)' != ''">$(DefineConstants);ProductVersion=$(ProductVersion)</DefineConstants>
+    <DefineConstants Condition="'$(BundleVersion)' != ''">$(DefineConstants);BundleVersion=$(BundleVersion)</DefineConstants>
+  </PropertyGroup>
+
+  <!-- MSI upgrade codes are generated based on the name of the installer, which typically includes the version and platform information. -->
+  <Target Name="GenerateUpgradeCode" BeforeTargets="CoreCompile">
+    <Error Condition="'$(InstallerPath)' == '' AND '$(UpgradeCode)' == ''"
+           Text="Unable to compute UpgradeCode. The InstallerPath property is not set." />
+
+    <!-- Only use the file name when generating the GUID. Full paths may be inconsistent across different build environments. -->
+    <GenerateGuidFromName Name="$([System.IO.Path]::GetFileName($(InstallerPath)))" Condition="'$(UpgradeCode)' == ''">
+      <Output TaskParameter="GeneratedGuid" PropertyName="UpgradeCode" />
+    </GenerateGuidFromName>
+
+    <PropertyGroup>
+      <DefineConstants>$(DefineConstants);UpgradeCode=$(UpgradeCode)</DefineConstants>
+    </PropertyGroup>
+  </Target>
+
+  <!-- This target does nothing. It's intended to allow ProjectReference items to specify a target that has
+       no build impact, but allow projects to participate in restore operations.  -->
+  <Target Name="Idle" />
+
+  <!-- This target is intended to catch changes that require someone to investigate. -->
+  <Target Name="ValidateBuild" BeforeTargets="CoreCompile">
+    <!-- Bundles must target x86 for back compat. -->
+    <Error Condition="'$(OutputType)' == 'Bundle' AND '$(InstallerPlatform)' != 'x86'"
+           Text="Bundles must target x86. InstallerPlatform=$(InstallerPlatform)" />
+  </Target>
+
+  <Target Name="GenerateWixpackPackage" AfterTargets="CoreCompile">
+    <PropertyGroup>
+      <WixpackWorkingDir>$(IntermediateOutputPath)wixpack</WixpackWorkingDir>
+      <WixpackOutputDir>$(ArtifactsNonShippingPackagesDir)</WixpackOutputDir>
+    </PropertyGroup>
+
+    <CreateWixBuildWixpack
+      BindTrackingFile="$(IntermediateOutputPath)$(BindTrackingFilePrefix)%(CultureGroup.OutputSuffix)$(BindTrackingFileExtension)"
+      Cultures="%(CultureGroup.Identity)"
+      DefineConstants="$(DefineConstants);$(SolutionDefineConstants);$(ProjectDefineConstants);$(ProjectReferenceDefineConstants)"
+      Extensions="@(_ResolvedWixExtensionPaths)"
+      InstallerPlatform="$(InstallerPlatform)"
+      InstallerFile="$(IntermediateOutputPath)%(CultureGroup.OutputFolder)$(TargetFileName)"
+      IntermediateDirectory="$(IntermediateOutputPath)%(CultureGroup.OutputFolder)"
+      OutputFolder="$(WixpackOutputDir)"
+      OutputType="$(OutputType)"
+      PdbFile="$(IntermediateOutputPath)%(CultureGroup.OutputFolder)$(TargetPdbFileName)"
+      PdbType="$(DebugType)"
+      SourceFiles="@(Compile)"
+      WixpackWorkingDir="$(WixpackWorkingDir)">
+      <Output TaskParameter="OutputFile" PropertyName="_WixBuildCommandPackageNameOutput" />
+    </CreateWixBuildWixpack>
+  </Target>
+</Project>