Page MenuHomePhabricator

packaging: use PyOxidizer for producing WiX MSI installer
ClosedPublic

Authored by indygreg on May 6 2021, 8:00 PM.

Details

Summary

We recently taught our in-tree PyOxidizer configuration file to
produce MSI installers with WiX using PyOxidizer's built-in
support for doing so.

This commit changes our WiX + PyOxidizer installer generation
code to use this functionality.

After this change, all the Python packaging code is doing is the
following:

  • Building HTML documentation
  • Making gettext available to the build process.
  • Munging CLI arguments to variables for the pyoxidizer execution.
  • Invoking pyoxidizer build.
  • Copying the produced .msi to the dist/ directory.

Applying this stack on stable and rebuilding the 5.8 MSI installer
produced the following differences from the official 5.8 installer:

  • .exe and .pyd files aren't byte identical (this is expected).
  • Various .dist-info/ directories have different names due to older versions of PyOxidizer being buggy and not properly normalizing package names. (The new behavior is correct.)
  • Various *.dist-info/RECORD files are different due to content divergence of files (this is expected).
  • The python38.dll differs due to newer PyOxidizer shipping a newer version of Python 3.8.
  • We now ship python3.dll because PyOxidizer now includes this file by default.
  • The vcruntime140.dll differs because newer PyOxidizer installs a newer version. We also now ship a vcruntime140_1.dll because newer versions of the redistributable ship 2 files now.

The WiX GUIDs and IDs of installed files have likely changed as a
result of PyOxidizer's different mechanism for generating those
identifiers. This means that an upgrade install of the MSI will
replace files instead of doing an incremental update. This is
likely harmless and we've incurred this kind of breakage before.

As far as I can tell, the new PyOxidizer-built MSI is functionally
equivalent to the old method. Once we drop support for Python 2.7
MSI installers, we can delete the WiX code from the repository.

This commit temporarily drops support for extra .wxs files. We
raise an exception instead of silently not using them, which I think
is appropriate. We should be able to add support back in by injecting
state into pyoxidizer.bzl via --var. I just didn't want to expend
cognitive load to think about the solution as part of this series.

Diff Detail

Repository
rHG Mercurial
Branch
default
Lint
No Linters Available
Unit
No Unit Test Coverage

Event Timeline

indygreg created this revision.May 6 2021, 8:00 PM
baymax updated this revision to Diff 27759.May 7 2021, 11:30 AM

✅ refresh by Heptapod after a successful CI run (🐙 💚)

baymax updated this revision to Diff 27796.May 10 2021, 11:38 AM

✅ refresh by Heptapod after a successful CI run (🐙 💚)

mharbison72 accepted this revision.May 11 2021, 12:15 AM
This revision is now accepted and ready to land.May 11 2021, 12:15 AM

This commit temporarily drops support for extra .wxs files. We
raise an exception instead of silently not using them, which I think
is appropriate. We should be able to add support back in by injecting
state into pyoxidizer.bzl via --var.

Any updates on this? Our internal packaging for Windows depends on the "extra .wxs" feature so it's currently broken. Maybe PyOxidizer has already gained that --var feature?