This is an archive of the discontinued Mercurial Phabricator instance.

Differential D8003

wix: more robust normalization of RC version components
ClosedPublic

Authored by indygreg on Jan 24 2020, 11:34 PM.

Details

Reviewers
pulkit
Group Reviewers
hg-reviewers
Commits
rHG8d653abed861: wix: more robust normalization of RC version components
Summary

MSI has strict version requirements where the format is
A.B.C[.D] and all fields must be numeric
(https://docs.microsoft.com/en-us/windows/win32/msi/productversion?redirectedfrom=MSDN).
Only the first 3 are used by the installer itself.

Mercurial's version strings can have rcN and an optional
+<commit>-<date> fragment at the end.

This commit teaches the MSI version normalization to handle
both of these more robustly.

Before, we would throw away the .rcN component completely.
e.g. 5.3rc1 would get normalized to 5.3.0. And worse,
5.3rc0+5-abcdef would get normalized to 5.3.5.

After this commit, presence of an .rcN provides the
value for a 4th field. e.g. 5.3rc1 -> 5.3.0.1. In
addition, the commit count from the + suffix gets
normalized into the 4th version component, but only if
the original version string didn't have a 4th version
component or if no rcN is present. e.g. 5.3+5-abcdef
is 5.3.0.5.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

indygreg created this revision.Jan 24 2020, 11:34 PM
indygreg added a comment.Jan 24 2020, 11:38 PM

This series is for stable in case it gets missed in the Phabricator UI.

pulkit accepted this revision.Jan 25 2020, 6:15 PM
This revision is now accepted and ready to land.Jan 25 2020, 6:15 PM
indygreg added a commit: rHG8d653abed861: wix: more robust normalization of RC version components.Jan 25 2020, 7:02 PM
Closed by commit rHG8d653abed861: wix: more robust normalization of RC version components (authored by indygreg). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mcontrib/packaging/hgpackaging/wix.py (48 lines)

Diff 19609

contrib/packaging/hgpackaging/wix.py

m = re.search('version = b"(.*)"', source) m = re.search('version = b"(.*)"', source)
return m.group(1) return m.group(1)
def normalize_version(version): def normalize_version(version):
"""Normalize Mercurial version string so WiX accepts it. """Normalize Mercurial version string so WiX accepts it.
Version strings have to be numeric X.Y.Z. Version strings have to be numeric ``A.B.C[.D]`` to conform with MSI's
""" requirements.
We normalize RC version or the commit count to a 4th version component.
We store this in the 4th component because ``A.B.C`` releases do occur
and we want an e.g. ``5.3rc0`` version to be semantically less than a
``5.3.1rc2`` version. This requires always reserving the 3rd version
component for the point release and the ``X.YrcN`` release is always
point release 0.
In the case of an RC and presence of ``+`` suffix data, we can't use both
because the version format is limited to 4 components. We choose to use
RC and throw away the commit count in the suffix. This means we could
produce multiple installers with the same normalized version string.
>>> normalize_version("5.3")
'5.3.0'
>>> normalize_version("5.3rc0")
'5.3.0.0'
>>> normalize_version("5.3rc1")
'5.3.0.1'
>>> normalize_version("5.3rc1+2-abcdef")
'5.3.0.1'
>>> normalize_version("5.3+2-abcdef")
'5.3.0.2'
"""
if '+' in version: if '+' in version:
version, extra = version.split('+', 1) version, extra = version.split('+', 1)
else: else:
extra = None extra = None
# 4.9rc0 # 4.9rc0
if version[:-1].endswith('rc'): if version[:-1].endswith('rc'):
rc = int(version[-1:])
version = version[:-3] version = version[:-3]
else:
rc = None
# Ensure we have at least X.Y version components.
versions = [int(v) for v in version.split('.')] versions = [int(v) for v in version.split('.')]
while len(versions) < 3: while len(versions) < 3:
versions.append(0) versions.append(0)
major, minor, build = versions[:3] if len(versions) < 4:
if rc is not None:
if extra: versions.append(rc)
elif extra:
# <commit count>-<hash>+<date> # <commit count>-<hash>+<date>
build = int(extra.split('-')[0]) versions.append(int(extra.split('-')[0]))
return '.'.join('%d' % x for x in (major, minor, build)) return '.'.join('%d' % x for x in versions[0:4])
def ensure_vc90_merge_modules(build_dir): def ensure_vc90_merge_modules(build_dir):
x86 = ( x86 = (
download_entry( download_entry(
'vc9-crt-x86-msm', 'vc9-crt-x86-msm',
build_dir, build_dir,
local_name='microsoft.vcxx.crt.x86_msm.msm', local_name='microsoft.vcxx.crt.x86_msm.msm',