From 048b07c1cee2452a7dd477968e222ef04f8cfc0f Mon Sep 17 00:00:00 2001
From: Jaime Bernardo <jaime@janeasystems.com>
Date: Fri, 21 Mar 2025 10:39:27 +0000
Subject: [PATCH] [Installer]Properly update CmdPal on upgrade (#38070)

* [Installer]Properly update CmdPal on upgrade

* Update installer/PowerToysSetupCustomActions/CustomAction.cpp
---
 installer/PowerToysSetup/Product.wxs          | 11 ++++++
 .../CustomAction.cpp                          | 37 ++++++++++++++++++-
 .../CustomAction.def                          |  1 +
 3 files changed, 48 insertions(+), 1 deletion(-)

diff --git a/installer/PowerToysSetup/Product.wxs b/installer/PowerToysSetup/Product.wxs
index 2c99d84044..37256bdd68 100644
--- a/installer/PowerToysSetup/Product.wxs
+++ b/installer/PowerToysSetup/Product.wxs
@@ -179,6 +179,9 @@
       <Custom Action="UnRegisterContextMenuPackages" Before="RemoveFiles">
         Installed AND (REMOVE="ALL")
       </Custom>
+      <Custom Action="UnRegisterCmdPalPackage" Before="RemoveFiles">
+        Installed AND (NOT UPGRADINGPRODUCTCODE) AND (REMOVE="ALL")
+      </Custom>
       <Custom Action="UnsetAdvancedPasteAPIKey" Before="RemoveFiles">
         Installed AND (NOT UPGRADINGPRODUCTCODE) AND (REMOVE="ALL")
       </Custom>
@@ -439,6 +442,14 @@
                 DllEntry="UnRegisterContextMenuPackagesCA"
                   />
 
+    <CustomAction Id="UnRegisterCmdPalPackage"
+                  Return="ignore"
+                  Impersonate="yes"
+                  Execute="deferred"
+                  BinaryKey="PTCustomActions"
+                  DllEntry="UnRegisterCmdPalPackageCA"
+                  />
+
     <CustomAction Id="CheckGPO"
                   Return="check"
                   Impersonate="yes"
diff --git a/installer/PowerToysSetupCustomActions/CustomAction.cpp b/installer/PowerToysSetupCustomActions/CustomAction.cpp
index 84c86af124..d1898eea32 100644
--- a/installer/PowerToysSetupCustomActions/CustomAction.cpp
+++ b/installer/PowerToysSetupCustomActions/CustomAction.cpp
@@ -1081,6 +1081,41 @@ UINT __stdcall InstallCmdPalPackageCA(MSIHANDLE hInstall)
     return WcaFinalize(er);
 }
 
+UINT __stdcall UnRegisterCmdPalPackageCA(MSIHANDLE hInstall)
+{
+    using namespace winrt::Windows::Foundation;
+    using namespace winrt::Windows::Management::Deployment;
+
+    HRESULT hr = S_OK;
+    UINT er = ERROR_SUCCESS;
+
+    hr = WcaInitialize(hInstall, "UnRegisterCmdPalPackageCA");
+
+    try
+    {
+        // Packages to unregister
+        std::wstring packageToRemoveDisplayName {L"Microsoft.CommandPalette"};
+
+        if (!package::UnRegisterPackage(packageToRemoveDisplayName))
+        {
+            Logger::error(L"Failed to unregister package: " + packageToRemoveDisplayName);
+            er = ERROR_INSTALL_FAILURE;
+        }
+    }
+    catch (std::exception &e)
+    {
+        std::string errorMessage{"Exception thrown while trying to unregister the CmdPal package: "};
+        errorMessage += e.what();
+        Logger::error(errorMessage);
+
+        er = ERROR_INSTALL_FAILURE;
+    }
+
+    er = er == ERROR_SUCCESS ? (SUCCEEDED(hr) ? ERROR_SUCCESS : ERROR_INSTALL_FAILURE) : er;
+    return WcaFinalize(er);
+}
+
+
 UINT __stdcall UnRegisterContextMenuPackagesCA(MSIHANDLE hInstall)
 {
     using namespace winrt::Windows::Foundation;
@@ -1094,7 +1129,7 @@ UINT __stdcall UnRegisterContextMenuPackagesCA(MSIHANDLE hInstall)
     try
     {
         // Packages to unregister
-        const std::vector<std::wstring> packagesToRemoveDisplayName{{L"PowerRenameContextMenu"}, {L"ImageResizerContextMenu"}, {L"FileLocksmithContextMenu"}, {L"NewPlusContextMenu"}, {L"Microsoft.CommandPalette"}};
+        const std::vector<std::wstring> packagesToRemoveDisplayName{{L"PowerRenameContextMenu"}, {L"ImageResizerContextMenu"}, {L"FileLocksmithContextMenu"}, {L"NewPlusContextMenu"}};
 
         for (auto const &package : packagesToRemoveDisplayName)
         {
diff --git a/installer/PowerToysSetupCustomActions/CustomAction.def b/installer/PowerToysSetupCustomActions/CustomAction.def
index e91060b764..6e42da27c5 100644
--- a/installer/PowerToysSetupCustomActions/CustomAction.def
+++ b/installer/PowerToysSetupCustomActions/CustomAction.def
@@ -20,6 +20,7 @@ EXPORTS
 	InstallDSCModuleCA
 	InstallCmdPalPackageCA
 	UnApplyModulesRegistryChangeSetsCA
+	UnRegisterCmdPalPackageCA
 	UnRegisterContextMenuPackagesCA
 	UninstallEmbeddedMSIXCA
 	UninstallDSCModuleCA