Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update MSI installer to prevent upgrades and not partially remove Chocolatey #3290

Merged
merged 3 commits into from
Aug 2, 2023
Merged

Update MSI installer to prevent upgrades and not partially remove Chocolatey #3290

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
45cb1f3
(#3286) Do not remove any files on MSI uninstall
corbob Aug 1, 2023
8219e2f
(#3286) Prevent MSI Upgrades
corbob Aug 1, 2023
b2812ab
(#3286) Adjust wording of upgrade failure message
corbob Aug 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions src/chocolatey.install/chocolatey.en-us.wxl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
<String Id="NewerVersionInstalled" Overridable="yes">A newer version of Chocolatey is already installed.</String>
<String Id="ProfileAdditionDescription" Overridable="yes">Add the Chocolatey Helpers to your PowerShell Profile to enable tab-completions.
Defaults to adding to the AllUsersAllHosts profile.</String>
<String Id="RequiresDotNet48" Overridable="yes">This application requires .NET Framework 4.8. Please install the .NET Framework then run this installer again.</String>
<String Id="ToolsFolderDescription" Overridable="yes">Sets the location for the Tools Folder</String>
</WixLocalization>
<String Id="RequiresDotNet48" Overridable="yes">Chocolatey CLI requires .NET Framework 4.8. Please install the .NET Framework then run this installer again.</String>
<String Id="UpgradeNotAllowed" Overridable="yes">The Chocolatey CLI MSI is intended for installation only. Please run 'choco upgrade chocolatey' from an elevated terminal window to upgrade.</String>
<String Id="ToolsFolderDescription" Overridable="yes">Sets the location for the Tools Folder.</String>
</WixLocalization>
20 changes: 2 additions & 18 deletions src/chocolatey.install/chocolatey.wxs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

<Product Name="$(var.ProductName)" Id="*" UpgradeCode="$(var.ProductCode)" Language="1033" Manufacturer="$(var.ProductVendor)" Codepage="1252" Version="$(var.ProductVersion)">
<Package Id='*' Platform='x86' Keywords='Installer' Description="$(var.ProductName)" Comments="$(var.ProductSummary)" InstallScope="perMachine" InstallerVersion="200" Compressed="yes" />
<MajorUpgrade Schedule="afterInstallInitialize" DowngradeErrorMessage="!(loc.NewerVersionInstalled)" />
<MajorUpgrade Schedule="afterInstallInitialize" DowngradeErrorMessage="!(loc.NewerVersionInstalled)" Disallow="yes" DisallowUpgradeErrorMessage="!(loc.UpgradeNotAllowed)" />
<Media Id="1" Cabinet="$(var.ArtifactName).cab" EmbedCab="yes" />

<!-- Installation Properties -->
Expand All @@ -23,10 +23,6 @@
<Property Id="ARPNOREPAIR" Value="yes" Secure="yes" /> <!-- Remove repair from post-install options, as it will not work with the script method -->
<Property Id="ARPNOMODIFY" Value="yes" Secure="yes" /> <!-- Remove modify from post-install options, as it will not work with the script method -->

<CustomAction Id="SetHelpersDirectoryPath" Property="HelpersDirectoryPath" Value="[INSTALLDIR]\\helpers" />
<CustomAction Id="SetRedirectsDirectoryPath" Property="RedirectsDirectoryPath" Value="[INSTALLDIR]\\redirects" />
<CustomAction Id="SetToolsDirectoryPath" Property="ToolsDirectoryPath" Value="[INSTALLDIR]\\tools" />

Comment on lines -26 to -29
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are you removing these custom actions?

I was under the impression they are required to be available?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These custom actions only fire when Chocolatey is already installed, which only happens on an upgrade, change, repair, or uninstall. None of which we currently do anything with.

<PropertyRef Id="WIX_IS_NETFRAMEWORK_48_OR_LATER_INSTALLED" />
<Condition Message="!(loc.RequiresDotNet48)">
<![CDATA[Installed OR WIX_IS_NETFRAMEWORK_48_OR_LATER_INSTALLED]]>
Expand All @@ -35,17 +31,13 @@
<!-- Custom Actions to Install Chocolatey -->
<SetProperty Id="InstallChocolatey"
Before="InstallChocolatey"
Sequence="execute"
Sequence="execute"
Value="&quot;[SystemFolder]\WindowsPowerShell\v1.0\powershell.exe&quot; -NoProfile -ExecutionPolicy Bypass -Command &quot;$env:ChocolateyInstall='[INSTALLDIR]'; &amp; '[#ChocolateyInstall]' -ChocolateyDownloadUrl '[#ChocolateyNupkg]' -UseNativeUnzip&quot;" />
<CustomAction Id="InstallChocolatey" BinaryKey="WixCA" DllEntry="WixQuietExec" Execute="deferred" Return="check" Impersonate="yes" />

<!-- Custom Additions to the InstallExecuteSequence (e.g. the actions above) -->
<InstallExecuteSequence>
<Custom Action="InstallChocolatey" After="InstallFiles"><![CDATA[NOT Installed]]></Custom>
<!-- Set these values during the uninstall such that we can remove the folders -->
<Custom Action="SetHelpersDirectoryPath" Before="CostInitialize"><![CDATA[Installed]]></Custom>
<Custom Action="SetRedirectsDirectoryPath" Before="CostInitialize"><![CDATA[Installed]]></Custom>
<Custom Action="SetToolsDirectoryPath" Before="CostInitialize"><![CDATA[Installed]]></Custom>
Comment on lines -45 to -48
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These custom actions only fire when Chocolatey is already installed, which only happens on an upgrade, change, repair, or uninstall. None of which we currently do anything with.

</InstallExecuteSequence>

<!-- Installation Layout - primarily 'temporary' install files, unlike most MSI installers, as we run the standard install script -->
Expand All @@ -54,14 +46,6 @@
<Directory Id="INSTALLDIR" Name="chocolatey">
<Component Id="ChocolateyInstallDirectory" Guid="{9E538CD6-6F07-43E5-B8E2-ED31995F3D1C}" Win64="no">
<CreateFolder />
<RemoveFile Id="ChocoEXE" On="uninstall" Name="choco.exe" />
<RemoveFile Id="ChocoIgnore" On="uninstall" Name="choco.exe.ignore" />
<RemoveFile Id="ChocoManifest" On="uninstall" Name="choco.exe.manifest" />
<RemoveFile Id="ChocoCredits" On="uninstall" Name="CREDITS.txt" />
<RemoveFile Id="ChocoLicense" On="uninstall" Name="LICENSE.txt" />
<util:RemoveFolderEx Id="HelpersDirectory" On="uninstall" Property="HelpersDirectoryPath" />
<util:RemoveFolderEx Id="RedirectsDirectory" On="uninstall" Property="RedirectsDirectoryPath" />
<util:RemoveFolderEx Id="ToolsDirectory" On="uninstall" Property="ToolsDirectoryPath" />
Comment on lines -57 to -64
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So we intend to remove the support to uninstall Chocolatey CLI through the MSI?

Or mainly making it a no-op?

Copy link
Member

@pauby pauby Aug 2, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be a no-op. The goal is to remove from Programs and Features but not actually remove Chocolatey itself in this version. We should notify the user to that @corbob ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, in this version we're going to make it a no-op since the previous behaviour doesn't actually remove all of Chocolatey, and instead leaves it in a broken state that doesn't allow reinstallation without manual intervention. I'll be doing up an ADR for this with the reasoning and options considered. The main reason to do a no-op right now is we would rather have a non operative uninstall than one that isn't working and don't want to rush the work of having a proper uninstall.

With regards to notifying the user @pauby, I wasn't finding anything in my searching about changing things, but I just noticed some things in this diff that I think can work, so I'll look into that.

<Environment Id="ChocolateyInstallEnvVar" Action="set" Name="ChocolateyInstall" Permanent="no" System="yes" Value="[INSTALLDIR]" />
</Component>
</Directory>
Expand Down
Loading