Windows installer: fix shortcut folder removal issue, fix version upgrade issue

Author: PierreRaybaut

wix/generic-DataLab.wxs

@@ -1,17 +1,9 @@
 <!-- Copyright (c) DataLab Platform Developers, BSD 3-Clause license, see LICENSE file. -->
 <Wix xmlns="http://wixtoolset.org/schemas/v4/wxs"
     xmlns:ui="http://wixtoolset.org/schemas/v4/wxs/ui">
-    <Package Name="DataLab" ProductCode="b9f2e8d4-7c3a-4f1b-9e6d-5a8c2f1b4e9a" Language="1033" Version="{version}" Codepage="1252" Manufacturer="DataLab Platform Developers" UpgradeCode="e7a3f5c1-9d84-4b2a-a6f1-2c5d8e9b7a31" InstallerVersion="200" Scope="perUserOrMachine">
-        <Upgrade Id="e7a3f5c1-9d84-4b2a-a6f1-2c5d8e9b7a31">
-            <UpgradeVersion Minimum="1.0.0" Maximum="{version}" IncludeMinimum="yes" IncludeMaximum="no" OnlyDetect="no" Property="PREVIOUSVERSIONSINSTALLED" />
-            <UpgradeVersion Minimum="{version}" OnlyDetect="yes" Property="NEWERVERSIONDETECTED" />
-        </Upgrade>
-        <CustomAction Id="PreventDowngrade" Error="A newer version of [ProductName] is already installed." />
-        <InstallExecuteSequence>
-            <Custom Action="PreventDowngrade" After="FindRelatedProducts" Condition="NEWERVERSIONDETECTED" />
-            <RemoveExistingProducts After="InstallInitialize" />
-        </InstallExecuteSequence>
-        <Icon Id="DataLab.exe" SourceFile=".\resources\DataLab.ico" />
+    <Package Name="DataLab" ProductCode="{product_code}" Language="1033" Version="{version}" Codepage="1252" Manufacturer="DataLab Platform Developers" UpgradeCode="e7a3f5c1-9d84-4b2a-a6f1-2c5d8e9b7a31" InstallerVersion="200" Scope="perUserOrMachine">
+        <MajorUpgrade DowngradeErrorMessage="A newer or same version of [ProductName] is already installed. Please uninstall the existing version before installing this one." />
+        <Icon Id="DataLabIcon" SourceFile=".\resources\DataLab.ico" />
         <Icon Id="DataLabResetIcon" SourceFile=".\resources\DataLab-Reset.ico" />
         <WixVariable Id="WixUILicenseRtf" Value=".\wix\license.rtf" />
         <WixVariable Id="WixUIDialogBmp" Value=".\wix\dialog.bmp" />
@@ -51,12 +43,21 @@
                 <File Source=".\dist\DataLab\manifest.json" />
             </Component>
             <!-- Automatically inserted components -->
-            <Component Id="PC_Shortcuts" Directory="ApplicationProgramsFolder" Guid="858c3c36-978e-4edb-a2c3-cf5c91588bcf">
-                <Shortcut Id="ApplicationStartMenuShortcut" Name="{display_folder_name}" Description="{display_folder_name}" Target="[INSTALLFOLDER]\DataLab.exe" WorkingDirectory="INSTALLFOLDER" />
+            <!-- Shortcut components: one component per shortcut with registry KeyPath -->
+            <Component Id="PC_Shortcut_Main" Directory="ApplicationProgramsFolder" Guid="*">
+                <Shortcut Id="ApplicationStartMenuShortcut" Name="{display_folder_name}" Description="{display_folder_name}" Target="[INSTALLFOLDER]\DataLab.exe" WorkingDirectory="INSTALLFOLDER" Icon="DataLabIcon" />
+                <RegistryValue Root="HKCU" Key="Software\[Manufacturer]\{install_folder_name}" Name="shortcut_main" Type="integer" Value="1" KeyPath="yes" />
+                <RemoveFolder Id="RemoveApplicationProgramsFolder1" Directory="ApplicationProgramsFolder" On="uninstall" />
+            </Component>
+            <Component Id="PC_Shortcut_Reset" Directory="ApplicationProgramsFolder" Guid="*">
                 <Shortcut Id="ResetApplicationStartMenuShortcut" Name="Reset {display_folder_name}" Description="Resets {display_folder_name} configuration" Target="[INSTALLFOLDER]\DataLab.exe" Arguments="--reset" WorkingDirectory="INSTALLFOLDER" Icon="DataLabResetIcon" />
-                <Shortcut Id="UninstallProductShortcut" Name="Uninstall {display_folder_name}" Description="Uninstalls {display_folder_name}" Target="[System64Folder]msiexec.exe" Arguments="/x [ProductCode]" WorkingDirectory="INSTALLFOLDER" />
-                <RemoveFolder Id="ApplicationProgramsFolder" On="uninstall" />
-                <RegistryValue Root="HKCU" Key="Software\[Manufacturer]\{install_folder_name}" Name="installed" Type="integer" Value="1" KeyPath="yes" />
+                <RegistryValue Root="HKCU" Key="Software\[Manufacturer]\{install_folder_name}" Name="shortcut_reset" Type="integer" Value="1" KeyPath="yes" />
+                <RemoveFolder Id="RemoveApplicationProgramsFolder2" Directory="ApplicationProgramsFolder" On="uninstall" />
+            </Component>
+            <Component Id="PC_Shortcut_Uninstall" Directory="ApplicationProgramsFolder" Guid="*">
+                <Shortcut Id="UninstallProductShortcut" Name="Uninstall {display_folder_name}" Description="Uninstalls {display_folder_name}" Target="[System64Folder]msiexec.exe" Arguments="/x [ProductCode]" WorkingDirectory="INSTALLFOLDER" Icon="DataLabIcon" />
+                <RegistryValue Root="HKCU" Key="Software\[Manufacturer]\{install_folder_name}" Name="shortcut_uninstall" Type="integer" Value="1" KeyPath="yes" />
+                <RemoveFolder Id="RemoveApplicationProgramsFolder3" Directory="ApplicationProgramsFolder" On="uninstall" />
             </Component>
         </ComponentGroup>
     </Fragment>

wix/makewxs.py

@@ -74,6 +74,14 @@ def make_wxs(product_name: str, version: str) -> None:
     # User-friendly folder name: "DataLab 1.0"
     display_folder_name = f"{product_name} {major_minor}"
 
+    # Generate a deterministic ProductCode based on MAJOR version only
+    # All versions with the same major version (e.g., 1.0.0, 1.0.1, 1.1.0) will have
+    # the same ProductCode, preventing installation of multiple v1.x versions.
+    # Different major versions (v1.x vs v2.x) will have different ProductCodes,
+    # allowing them to be installed side-by-side.
+    upgrade_code = uuid.UUID("e7a3f5c1-9d84-4b2a-a6f1-2c5d8e9b7a31")
+    product_code = str(uuid.uuid5(upgrade_code, f"v{major_version}"))
+
     wix_dir = osp.abspath(osp.dirname(__file__))
     proj_dir = osp.join(wix_dir, os.pardir)
     dist_dir = osp.join(proj_dir, "dist", product_name)
@@ -162,6 +170,7 @@ def make_wxs(product_name: str, version: str) -> None:
     wxs = insert_text_after(dir_str, "<!-- Automatically inserted directories -->", wxs)
     wxs = insert_text_after(comp_str, "<!-- Automatically inserted components -->", wxs)
     wxs = wxs.replace("{version}", version_msi)
+    wxs = wxs.replace("{product_code}", product_code)
     wxs = wxs.replace("{install_folder_name}", install_folder_name)
     wxs = wxs.replace("{display_folder_name}", display_folder_name)
     with open(output_path, "w", encoding="utf-8") as fd: