Art des Upgrades
tl;dr: MajorUpgrade ab der initialen Version!
Folgendes Szenario: Ich baue mit WiX einen MSI-Installer für meine Software. Die Software hat die Version 1.0. Nun möchte ich meine Software auf v1.1 upgraden. Was tun?
WiX bietet mehrere Möglichkeiten, namentlich “Major Upgrades”, “Minor Upgrades”, sowie “Small Updates”, die sich ungefähr so definieren:
- Small Updates: Quasi ein Patch vorhandener Files, erfordert nicht (zwingend?) eine Änderung der Versionsnummer
- Minor Upgrade: Aktualisiert bestehende Files ohne die vorhandene Software zu deinstallieren. Kann aber Features oder Komponenten hinzufügen. Erfordert neue (=höhere) Versionsnummer
- Major Upgrade: “Deinstalliert das Produkt und installiert es neu”, erfordert neue (=höhere) Versionsummer und eine neue Product.Id (Achtung: Product.UpgradeCode “bleibt immer unverändert”)
Liest sich, als würde man meistens ein Minor Upgrade wollen. Internet sagt allerdings das Gegenteil, die Literatur* sieht Major Upgrades als “easier to implement than any other option” an, und last but not least empfiehlt WiX selbst:
When creating an .msi-based installer, you are strongly encouraged to include logic that supports Windows Installer major upgrades.
Was dabei nie so richtig, richtig klar wird (teilweise wird implizit das Gegenteil angedeutet): Beinhaltet nicht bereits Version 1.0 MajorUpgrade (sondern bspw. erst das erste Upgrade), dann funktioniert quasi nichts:
- v1.1 wird nicht als Update erkannt, sondern parallel installiert!
- Conditions funktionieren deshalb ebenfalls nicht wie erwartet, es gilt der Pfad wie bei Erstinstallation
- Downgrades werden nicht verhindert, weil ja beides parallel installiert wird
- …
- In anderen Worten: Eine Installation, deren Installer nicht
MajorUpgradeenthielt, wird von Upgrade/Downgrade-Logik komplett ignoriert!
Warum das dann nicht mandatorisch ist, wird wohl Microsofts Geheimnis bleiben.
*Nick Ramirez, “WiX 3.6: A Developer’s Guide to Windows Installer XML”, Seite 342
“Scheduling”
Per default deinstalliert ein MajorUpgrade die alte Version und installiert dann die neue. Das kann problematisch sein, denn ein Upgrade (engl. für “Verbesserung”, “Aufrüstung”!) sollte ja bspw. Konfigurationsdaten usw. behalten. Da hilft das Scheduling-Attribut:
|
1 |
<MajorUpgrade Schedule="afterInstallExecute" DowngradeErrorMessage="A newer version of [ProductName] is already installed."/> |
sorgt dafür, dass bestehende Dateien (und in diesem Fall auch Services) erhalten bleiben. Es wird quasi definiert, wann das bestehende Produkt entfernt werden soll, und afterInstallExecute sagt “nach der Installation des Upgrades” – natürlich wird dann nur noch entfernt, was in v1.1 nicht mehr benötigt wird.
Conditions
Bestimmte Schritte des Installers sollen nur bei Erstinstallation ausgeführt werden (etwa die Konfiguration durch den User, die Installation eines Services, …). Dafür gibt es Conditions, bzw. verschiedene States, auf die man prüfen kann – und das ist ziemlich unübersichtlich. Ich beschränke mich an dieser Stelle auf einen Stackoverflow-Post, der gute, sprechende Aliase definiert:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
<SetProperty After="FindRelatedProducts" Id="FirstInstall" Value="true"> NOT Installed AND NOT WIX_UPGRADE_DETECTED AND NOT WIX_DOWNGRADE_DETECTED </SetProperty> <SetProperty After="SetFirstInstall" Id="Upgrading" Value="true"> WIX_UPGRADE_DETECTED AND NOT (REMOVE="ALL") </SetProperty> <SetProperty After="RemoveExistingProducts" Id="RemovingForUpgrade" Sequence="execute" Value="true"> (REMOVE="ALL") AND UPGRADINGPRODUCTCODE </SetProperty> <SetProperty After="SetUpgrading" Id="Uninstalling" Value="true"> Installed AND (REMOVE="ALL") AND NOT (WIX_UPGRADE_DETECTED OR UPGRADINGPRODUCTCODE) </SetProperty> <SetProperty After="SetUninstalling" Id="Maintenance" Value="true"> Installed AND NOT Upgrading AND NOT Uninstalling AND NOT UPGRADINGPRODUCTCODE </SetProperty> |
