Allow patched package to be uninstalled.HEADmain

Normally, a patched package is detected as superseded and therefore a
normal uninstall takes no action. This change looks for applied patches
and allows a normal uninstall to remove the package.

Fixes https://github.com/wixtoolset/issues/issues/6350

8 files changed, 164 insertions, 4 deletions

diff --git a/src/burn/engine/msiengine.cpp b/src/burn/engine/msiengine.cpp
index 86fb0d9d..48ec0c81 100644
--- a/src/burn/engine/msiengine.cpp
+++ b/src/burn/engine/msiengine.cpp
@@ -50,7 +50,9 @@ static void RegisterSourceDirectory(
     __in BURN_PACKAGE* pPackage,
     __in_z LPCWSTR wzCacheDirectory
     );
-
+static BOOL PackageHasAppliedPatch(
+    __in BURN_PACKAGE* pPackage
+    );
 
 // function definitions
 
@@ -904,7 +906,22 @@ extern "C" HRESULT MsiEnginePlanCalculatePackage(
         else if ((BOOTSTRAPPER_REQUEST_STATE_ABSENT == pPackage->requested || BOOTSTRAPPER_REQUEST_STATE_CACHE == pPackage->requested) &&
                  !pPackage->fPermanent) // removing a package that should be removed.
         {
-            execute = BOOTSTRAPPER_PACKAGE_STATE_SUPERSEDED == pPackage->currentState ? BOOTSTRAPPER_ACTION_STATE_NONE : BOOTSTRAPPER_ACTION_STATE_UNINSTALL;
+            if (BOOTSTRAPPER_PACKAGE_STATE_SUPERSEDED == pPackage->currentState)
+            {
+                // If the package is superseded, check to see if there's a patch installed.
+                // A minor upgrade patch could be (usually is) the cause of the
+                // supersedence. In that case, we should ignore the supersedence that would
+                // normally prevent the uninstall. There is a gap in this logic: If a minor
+                // upgrade package were installed without a bundle, then a small update patch
+                // (which by definition doesn't change the version number) were installed,
+                // this check would allow the uninstall. If the minor upgrade were installed
+                // by a bundle, dependencies would keep the package installed.
+                execute = PackageHasAppliedPatch(pPackage) ? BOOTSTRAPPER_ACTION_STATE_UNINSTALL : BOOTSTRAPPER_ACTION_STATE_NONE;
+            }
+            else
+            {
+                execute = BOOTSTRAPPER_ACTION_STATE_UNINSTALL;
+            }
         }
         else if (BOOTSTRAPPER_REQUEST_STATE_FORCE_ABSENT == pPackage->requested)
         {
@@ -2265,6 +2282,7 @@ LExit:
     ReleaseStr(sczMspPath);
     ReleaseStr(sczCachedDirectory);
     ReleaseStr(sczPatches);
+
     return hr;
 }
 
@@ -2289,6 +2307,47 @@ static void RegisterSourceDirectory(
 
 LExit:
     ReleaseStr(sczMsiDirectory);
+}
+
+static BOOL PackageHasAppliedPatch(
+    __in BURN_PACKAGE* pPackage
+)
+{
+    HRESULT hr = S_OK;
+    BOOL fPatched = FALSE;
+    UINT er = ERROR_SUCCESS;
+    DWORD iPatch = 0;
+    WCHAR wzPatchCode[MAX_GUID_CHARS + 1] = {};
+    WCHAR wzTransforms[MAX_PATH] = {};
+    DWORD cchTransforms = countof(wzTransforms);
+    WCHAR wzPatchState[2] = {};
+    DWORD cchPatchState = countof(wzPatchState);
+
+    for (;;)
+    {
+        er = ::MsiEnumPatchesW(pPackage->Msi.sczProductCode, iPatch, wzPatchCode, wzTransforms, &cchTransforms);
+
+        if (ERROR_NO_MORE_ITEMS == er)
+        {
+            ExitFunction();
+        }
+        ExitOnWin32Error(er, hr, "Failed to enumerate patches for package %ls, product code %ls.", pPackage->sczId, pPackage->Msi.sczProductCode);
+
+        er = ::MsiGetPatchInfoExW(wzPatchCode, pPackage->Msi.sczProductCode, NULL, pPackage->fPerMachine ? MSIINSTALLCONTEXT_MACHINE : MSIINSTALLCONTEXT_USERUNMANAGED
+            , INSTALLPROPERTY_PATCHSTATE, wzPatchState, &cchPatchState);
+        ExitOnWin32Error(er, hr, "Failed to get patch info for patch %ls.", wzPatchCode);
+
+        if ('1' == wzPatchState[0])
+        {
+            fPatched = TRUE;
+
+            ExitFunction();
+        }
+
+        ++iPatch;
+    }
+
+LExit:
+    return fPatched;
 
-    return;
 }
diff --git a/src/test/burn/TestData/SlipstreamTests/BundleAv1_0_1/BundleAv1_0_1.wixproj b/src/test/burn/TestData/SlipstreamTests/BundleAv1_0_1/BundleAv1_0_1.wixproj
new file mode 100644
index 00000000..ac9cf71e
--- /dev/null
+++ b/src/test/burn/TestData/SlipstreamTests/BundleAv1_0_1/BundleAv1_0_1.wixproj
@@ -0,0 +1,19 @@
+<!-- Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. -->
+<Project Sdk="WixToolset.Sdk">
+  <PropertyGroup>
+    <OutputType>Bundle</OutputType>
+    <UpgradeCode>{62C28DAF-A13E-4F55-ACA1-FB843630789C}</UpgradeCode>
+  </PropertyGroup>
+  <ItemGroup>
+    <Compile Include="..\..\Templates\Bundle.wxs" Link="Bundle.wxs" />
+  </ItemGroup>
+  <ItemGroup>
+    <ProjectReference Include="..\PackageAv1\PackageAv1.wixproj" />
+    <ProjectReference Include="..\PatchAMinor\PatchAMinor.wixproj" />
+    <ProjectReference Include="..\..\TestBA\TestBAWixlib\testbawixlib.wixproj" />
+  </ItemGroup>
+  <ItemGroup>
+    <PackageReference Include="WixToolset.BootstrapperApplications.wixext" />
+    <PackageReference Include="WixToolset.NetFx.wixext" />
+  </ItemGroup>
+</Project>
diff --git a/src/test/burn/TestData/SlipstreamTests/BundleAv1_0_1/BundleAv1_0_1.wxs b/src/test/burn/TestData/SlipstreamTests/BundleAv1_0_1/BundleAv1_0_1.wxs
new file mode 100644
index 00000000..a14383d3
--- /dev/null
+++ b/src/test/burn/TestData/SlipstreamTests/BundleAv1_0_1/BundleAv1_0_1.wxs
@@ -0,0 +1,12 @@
+<!-- Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. -->
+
+<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs">
+  <Fragment>    
+    <PackageGroup Id="BundlePackages">
+      <MsiPackage Id="PackageA" SourceFile="$(var.PackageAv1.TargetPath)" Compressed="no">
+        <SlipstreamMsp Id="PatchAMinor" />
+      </MsiPackage>
+      <MspPackage Id="PatchAMinor" SourceFile="$(var.PatchAMinor.TargetPath)" Compressed="no" />
+    </PackageGroup>
+  </Fragment>
+</Wix>
diff --git a/src/test/burn/TestData/SlipstreamTests/PatchAMinor/PatchAMinor.wixproj b/src/test/burn/TestData/SlipstreamTests/PatchAMinor/PatchAMinor.wixproj
new file mode 100644
index 00000000..3deb2263
--- /dev/null
+++ b/src/test/burn/TestData/SlipstreamTests/PatchAMinor/PatchAMinor.wixproj
@@ -0,0 +1,12 @@
+<!-- Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. -->
+<Project Sdk="WixToolset.Sdk">
+  <PropertyGroup>
+    <OutputType>Patch</OutputType>
+    <TargetExt>.msp</TargetExt>
+    <SuppressSpecificWarnings>1079</SuppressSpecificWarnings>
+  </PropertyGroup>
+  <ItemGroup>
+    <ProjectReference Include="..\PackageAv1\PackageAv1.wixproj" />
+    <ProjectReference Include="..\PackageAv1_0_1\PackageAv1_0_1.wixproj" />
+  </ItemGroup>
+</Project>
diff --git a/src/test/burn/TestData/SlipstreamTests/PatchAMinor/PatchAMinor.wxs b/src/test/burn/TestData/SlipstreamTests/PatchAMinor/PatchAMinor.wxs
new file mode 100644
index 00000000..0f4abd2b
--- /dev/null
+++ b/src/test/burn/TestData/SlipstreamTests/PatchAMinor/PatchAMinor.wxs
@@ -0,0 +1,23 @@
+<!-- Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. -->
+
+<?ifndef TestVersion?>
+<?define TestVersion = 1.0.0.0?>
+<?endif?>
+
+<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs">
+    <Patch AllowRemoval="yes" Classification="Update" Description="Patch A minor upgrade in test $(var.TestGroupName)" DisplayName="$(var.TestGroupName) - Patch A minor upgrade" Manufacturer="Example Corporation" MinorUpdateTargetRTM="yes">
+        <Media Id="100" Cabinet="PatchA" EmbedCab="yes">
+            <PatchBaseline
+              Id="PatchA"
+              BaselineFile="$(var.PackageAv1.TargetDir)$(var.PackageAv1.TargetName).wixpdb"
+              UpdateFile="$(var.PackageAv1_0_1.TargetDir)$(var.PackageAv1_0_1.TargetName).wixpdb"
+            />
+        </Media>
+
+        <PatchFamily Id="A" Version="$(var.TestVersion)" Supersede="yes">
+          <ComponentRef Id="RegistryComponent" />
+          <PropertyRef Id="TestVersion" />
+          <PropertyRef Id="ProductVersion" />
+        </PatchFamily>
+    </Patch>
+</Wix>
diff --git a/src/test/burn/WixToolsetTest.BurnE2E/SlipstreamTests.cs b/src/test/burn/WixToolsetTest.BurnE2E/SlipstreamTests.cs
index d07e80f1..d4cf447d 100644
--- a/src/test/burn/WixToolsetTest.BurnE2E/SlipstreamTests.cs
+++ b/src/test/burn/WixToolsetTest.BurnE2E/SlipstreamTests.cs
@@ -18,7 +18,7 @@ namespace WixToolsetTest.BurnE2E
         private const string V101 = "1.0.1.0";
 
         [RuntimeFact]
-        public void CanInstallBundleWithSlipstreamedPatchThenRemoveIt()
+        public void CanInstallBundleWithSlipstreamedSmallUpdatePatchThenRemoveIt()
         {
             var testRegistryValue = "PackageA";
 
@@ -39,6 +39,28 @@ namespace WixToolsetTest.BurnE2E
             packageAv1.VerifyTestRegistryRootDeleted();
         }
 
+        [RuntimeFact]
+        public void CanInstallBundleWithSlipstreamedMinorUpgradePatchThenRemoveIt()
+        {
+            var testRegistryValue = "PackageA";
+
+            var packageAv1 = this.CreatePackageInstaller("PackageAv1");
+            var bundleA = this.CreateBundleInstaller("BundleAv1_0_1");
+
+            var packageAv1SourceCodeInstalled = packageAv1.GetInstalledFilePath("Package.wxs");
+            Assert.False(File.Exists(packageAv1SourceCodeInstalled), $"PackageAv1 payload should not be there on test start: {packageAv1SourceCodeInstalled}");
+
+            bundleA.Install();
+            bundleA.VerifyRegisteredAndInPackageCache();
+            Assert.True(File.Exists(packageAv1SourceCodeInstalled), String.Concat("Should have found PackageAv1 payload installed at: ", packageAv1SourceCodeInstalled));
+            packageAv1.VerifyTestRegistryValue(testRegistryValue, V101);
+
+            bundleA.Uninstall();
+            bundleA.VerifyUnregisteredAndRemovedFromPackageCache();
+            Assert.False(File.Exists(packageAv1SourceCodeInstalled), String.Concat("PackageAv1 payload should have been removed by uninstall from: ", packageAv1SourceCodeInstalled));
+            packageAv1.VerifyTestRegistryRootDeleted();
+        }
+
         /// <summary>
         /// BundleA installs PackageA with slipstreamed PatchA.
         /// BundleOnlyPatchA is installed which contains PatchA (which should be a no-op).
diff --git a/src/test/sandbox/TestSandbox.wsb b/src/test/sandbox/TestSandbox.wsb
index 01e11e6b..97c3c759 100644
--- a/src/test/sandbox/TestSandbox.wsb
+++ b/src/test/sandbox/TestSandbox.wsb
@@ -5,6 +5,11 @@
             <SandboxFolder>C:\build</SandboxFolder>
             <ReadOnly>true</ReadOnly>
         </MappedFolder>
+        <MappedFolder>
+            <HostFolder>..\..\..\build\logs</HostFolder>
+            <SandboxFolder>C:\logs</SandboxFolder>
+            <ReadOnly>false</ReadOnly>
+        </MappedFolder>
                 <MappedFolder>
             <HostFolder>.\</HostFolder>
             <SandboxFolder>C:\sandbox</SandboxFolder>
diff --git a/src/test/sandbox/startup.bat b/src/test/sandbox/startup.bat
index 52f550ee..90f04f5f 100644
--- a/src/test/sandbox/startup.bat
+++ b/src/test/sandbox/startup.bat
@@ -1,5 +1,13 @@
 @setlocal
 @echo off
+
+
+::// Fix Sandbox glacial perf (24H2-???)
+:://
+REG ADD HKLM\SYSTEM\CurrentControlSet\Control\CI\Policy /v VerifiedAndReputablePolicyState /t REG_DWORD /d 0 /f
+CITOOL -r -j
+
+
 SET DOTNET_VERSION=8.0
 SET SANDBOX_FILES=C:\sandbox