Add Experimental Argument for UninstallPrevious in Upgrade Flow

doc/Settings.md

@@ -254,6 +254,17 @@ You can enable the feature as shown below.
    },
 ```
 
+### uninstallPreviousArgument
+
+This feature enables the Windows Package Manager to override the upgrade behavior to UninstallPrevious by passing the `--uninstall-previous` argument with the upgrade or install command. 
+You can enable the feature as shown below.
+
+```json
+   "experimentalFeatures": {
+       "uninstallPreviousArgument": true
+   },
+```
+
 ### dependencies
 
 Experimental feature with the aim of managing dependencies, as of now it only shows package dependency information. You can enable the feature as shown below.

schemas/JSON/settings/settings.schema.0.2.json

@@ -213,6 +213,11 @@
           "description": "Enable argument to open default logs location",
           "type": "boolean",
           "default": false
+        },
+        "uninstallPreviousArgument": {
+          "description": "Enable argument to override upgrade behavior to UninstallPrevious",
+          "type": "boolean",
+          "default": false
         }
       }
     }

src/AppInstallerCLICore/Argument.cpp

@@ -105,6 +105,8 @@ namespace AppInstaller::CLI
             return Argument{ "product-code"_liv, NoAlias, Args::Type::ProductCode, Resource::String::ProductCodeArgumentDescription, ArgumentType::Standard, false };
         case Args::Type::OpenLogs:
             return Argument{ "open-logs"_liv, NoAlias, "logs"_liv, Args::Type::OpenLogs, Resource::String::OpenLogsArgumentDescription, ArgumentType::Flag, ExperimentalFeature::Feature::OpenLogsArgument};
+        case Args::Type::UninstallPrevious:
+            return Argument{ "uninstall-previous"_liv, NoAlias, Args::Type::UninstallPrevious, Resource::String::UninstallPreviousArgumentDescription, ArgumentType::Flag, ExperimentalFeature::Feature::UninstallPreviousArgument };
         case Args::Type::Force:
             return Argument{ "force"_liv, NoAlias, Args::Type::Force, Resource::String::ForceArgumentDescription, ArgumentType::Flag, false };
         default:

src/AppInstallerCLICore/Commands/InstallCommand.cpp

@@ -47,6 +47,7 @@ namespace AppInstaller::CLI
             Argument::ForType(Args::Type::CustomHeader),
             Argument::ForType(Args::Type::AcceptSourceAgreements),
             Argument::ForType(Args::Type::Rename),
+            Argument::ForType(Args::Type::UninstallPrevious),
             Argument::ForType(Args::Type::Force),
         };
     }

src/AppInstallerCLICore/Commands/UpgradeCommand.cpp

@@ -107,6 +107,7 @@ namespace AppInstaller::CLI
             Argument::ForType(Execution::Args::Type::CustomHeader),
             Argument{ "all"_liv, 'r', "recurse"_liv, Args::Type::All, Resource::String::UpdateAllArgumentDescription, ArgumentType::Flag },
             Argument{ "include-unknown"_liv, 'u', "unknown"_liv, Args::Type::IncludeUnknown, Resource::String::IncludeUnknownArgumentDescription, ArgumentType::Flag },
+            Argument::ForType(Args::Type::UninstallPrevious),
             Argument::ForType(Args::Type::Force),
         };
     }

src/AppInstallerCLICore/ExecutionArgs.h

@@ -83,6 +83,7 @@ namespace AppInstaller::CLI::Execution
             // Upgrade command
             All, // Used in Update command to update all installed packages to latest
             IncludeUnknown, // Used in Upgrade command to allow upgrades of packages with unknown versions
+            UninstallPrevious, // Used in Upgrade command to override the default manifest behavior to UninstallPrevious
 
             // Show command
             ListVersions, // Used in Show command to list all available versions of an app

src/AppInstallerCLICore/Resources.h

@@ -408,6 +408,7 @@ namespace AppInstaller::CLI::Resource
         WINGET_DEFINE_RESOURCE_STRINGID(UninstallFailedWithCode);
         WINGET_DEFINE_RESOURCE_STRINGID(UninstallFlowStartingPackageUninstall);
         WINGET_DEFINE_RESOURCE_STRINGID(UninstallFlowUninstallSuccess);
+        WINGET_DEFINE_RESOURCE_STRINGID(UninstallPreviousArgumentDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(UnrecognizedCommand);
         WINGET_DEFINE_RESOURCE_STRINGID(UnsupportedArgument);
         WINGET_DEFINE_RESOURCE_STRINGID(UpdateAllArgumentDescription);

src/AppInstallerCLICore/Workflows/InstallFlow.cpp

@@ -257,6 +257,7 @@ namespace AppInstaller::CLI::Workflow
     {
         bool isUpdate = WI_IsFlagSet(context.GetFlags(), Execution::ContextFlag::InstallerExecutionUseUpdate);
         UpdateBehaviorEnum updateBehavior = context.Get<Execution::Data::Installer>().value().UpdateBehavior;
+        bool doUninstallPrevious = isUpdate && (updateBehavior == UpdateBehaviorEnum::UninstallPrevious || context.Args.Contains(Execution::Args::Type::UninstallPrevious));
 
         switch (m_installerType)
         {
@@ -266,7 +267,7 @@ namespace AppInstaller::CLI::Workflow
         case InstallerTypeEnum::Msi:
         case InstallerTypeEnum::Nullsoft:
         case InstallerTypeEnum::Wix:
-            if (isUpdate && updateBehavior == UpdateBehaviorEnum::UninstallPrevious)
+            if (doUninstallPrevious)
             {
                 context <<
                     GetUninstallInfo <<
@@ -291,7 +292,7 @@ namespace AppInstaller::CLI::Workflow
                 (isUpdate ? MSStoreUpdate : MSStoreInstall);
             break;
         case InstallerTypeEnum::Portable:
-            if (isUpdate && updateBehavior == UpdateBehaviorEnum::UninstallPrevious)
+            if (doUninstallPrevious)
             {
                 context <<
                     GetUninstallInfo <<

src/AppInstallerCLIE2ETests/BaseCommand.cs

@@ -87,6 +87,7 @@ public void InitializeAllFeatures(bool status)
             this.ConfigureFeature("directMSI", status);
             this.ConfigureFeature("zipInstall", status);
             this.ConfigureFeature("openLogsArgument", status);
+            this.ConfigureFeature("uninstallPreviousArgument", status);
         }
     }
 }

src/AppInstallerCLIE2ETests/FeaturesCommand.cs

@@ -53,6 +53,7 @@ public void EnableExperimentalFeatures()
             this.ConfigureFeature("experimentalCmd", true);
             this.ConfigureFeature("directMSI", true);
             this.ConfigureFeature("openLogsArgument", true);
+            this.ConfigureFeature("uninstallPreviousArgument", true);
             var result = TestCommon.RunAICLICommand("features", string.Empty);
             Assert.True(result.StdOut.Contains("Enabled"));
         }

src/AppInstallerCLIE2ETests/SetUpFixture.cs

@@ -158,6 +158,7 @@ public void InitializeWingetSettings()
                     dependencies = false,
                     directMSI = false,
                     openLogsArgument = false,
+                    uninstallPreviousArgument = false,
                 },
                 debugging = new
                 {

src/AppInstallerCLIPackage/Shared/Strings/en-us/winget.resw

@@ -663,6 +663,9 @@ They can be configured through the settings file 'winget settings'.</value>
   <data name="UnexpectedErrorExecutingCommand" xml:space="preserve">
     <value>An unexpected error occurred while executing the command:</value>
   </data>
+  <data name="UninstallPreviousArgumentDescription" xml:space="preserve">
+    <value>Uninstall the previous version of the package during upgrade</value>
+  </data>
   <data name="UnrecognizedCommand" xml:space="preserve">
     <value>Unrecognized command</value>
   </data>

src/AppInstallerCommonCore/ExperimentalFeature.cpp

@@ -48,6 +48,8 @@ namespace AppInstaller::Settings
                 return userSettings.Get<Setting::EFOpenLogsArgument>();
             case ExperimentalFeature::Feature::Pinning:
                 return userSettings.Get<Setting::EFPinning>();
+            case ExperimentalFeature::Feature::UninstallPreviousArgument:
+                return userSettings.Get<Setting::EFUninstallPreviousArgument>();
             default:
                 THROW_HR(E_UNEXPECTED);
             }
@@ -85,6 +87,8 @@ namespace AppInstaller::Settings
             return ExperimentalFeature{ "Open Logs Argument", "openLogsArgument", "https://aka.ms/winget-settings", Feature::OpenLogsArgument };
         case Feature::Pinning:
             return ExperimentalFeature{ "Package Pinning", "pinning", "https://aka.ms/winget-settings", Feature::Pinning};
+        case Feature::UninstallPreviousArgument:
+            return ExperimentalFeature{ "Uninstall Previous Argument", "uninstallPreviousArgument", "https://aka.ms/winget-settings", Feature::UninstallPreviousArgument };
         default:
             THROW_HR(E_UNEXPECTED);
         }

src/AppInstallerCommonCore/Public/winget/ExperimentalFeature.h

@@ -26,6 +26,7 @@ namespace AppInstaller::Settings
             ZipInstall = 0x4,
             OpenLogsArgument = 0x8,
             Pinning = 0x10,
+            UninstallPreviousArgument = 0x20,
             Max, // This MUST always be after all experimental features
 
             // Features listed after Max will not be shown with the features command

src/AppInstallerCommonCore/Public/winget/UserSettings.h

@@ -80,6 +80,7 @@ namespace AppInstaller::Settings
         EFZipInstall,
         EFOpenLogsArgument,
         EFPinning,
+        EFUninstallPreviousArgument,
         // Telemetry
         TelemetryDisable,
         // Install behavior
@@ -150,6 +151,7 @@ namespace AppInstaller::Settings
         SETTINGMAPPING_SPECIALIZATION(Setting::EFZipInstall, bool, bool, false, ".experimentalFeatures.zipInstall"sv);
         SETTINGMAPPING_SPECIALIZATION(Setting::EFOpenLogsArgument, bool, bool, false, ".experimentalFeatures.openLogsArgument"sv);
         SETTINGMAPPING_SPECIALIZATION(Setting::EFPinning, bool, bool, false, ".experimentalFeatures.pinning"sv);
+        SETTINGMAPPING_SPECIALIZATION(Setting::EFUninstallPreviousArgument, bool, bool, false, ".experimentalFeatures.uninstallPreviousArgument"sv);
         // Telemetry
         SETTINGMAPPING_SPECIALIZATION(Setting::TelemetryDisable, bool, bool, false, ".telemetry.disable"sv);
         // Install behavior

src/AppInstallerCommonCore/UserSettings.cpp

@@ -250,6 +250,7 @@ namespace AppInstaller::Settings
         WINGET_VALIDATE_PASS_THROUGH(EFZipInstall)
         WINGET_VALIDATE_PASS_THROUGH(EFOpenLogsArgument)
         WINGET_VALIDATE_PASS_THROUGH(EFPinning)
+        WINGET_VALIDATE_PASS_THROUGH(EFUninstallPreviousArgument)
         WINGET_VALIDATE_PASS_THROUGH(TelemetryDisable)
         WINGET_VALIDATE_PASS_THROUGH(InteractivityDisable)
         WINGET_VALIDATE_PASS_THROUGH(EnableSelfInitiatedMinidump)