( )⚙ D9437 dispatch: print the version of the extension being blamed in a bug report

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D9437

dispatch: print the version of the extension being blamed in a bug report
ClosedPublic

Authored by mharbison72 on Nov 27 2020, 11:48 PM.

Details

Reviewers
pulkit
Group Reviewers
hg-reviewers
Commits
rHGc26cb33e5219: dispatch: print the version of the extension being blamed in a bug report
Summary

I don't know of a lot of extensions using this, but it seems like useful info in
a bug report.

Diff Detail

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

Revision Contents
Changeset List

PathPackages
Mmercurial/dispatch.py (14 lines)
Mtests/test-extension.t (12 lines)

Diff 23757

mercurial/dispatch.py

# For compatibility checking, we discard the portion of the hg # For compatibility checking, we discard the portion of the hg
# version after the + on the assumption that if a "normal # version after the + on the assumption that if a "normal
# user" is running a build with a + in it the packager # user" is running a build with a + in it the packager
# probably built from fairly close to a tag and anyone with a # probably built from fairly close to a tag and anyone with a
# 'make local' copy of hg (where the version number can be out # 'make local' copy of hg (where the version number can be out
# of date) will be clueful enough to notice the implausible # of date) will be clueful enough to notice the implausible
# version number and try updating. # version number and try updating.
ct = util.versiontuple(n=2) ct = util.versiontuple(n=2)
worst = None, ct, b'' worst = None, ct, b'', b''
if ui.config(b'ui', b'supportcontact') is None: if ui.config(b'ui', b'supportcontact') is None:
for name, mod in extensions.extensions(): for name, mod in extensions.extensions():
# 'testedwith' should be bytes, but not all extensions are ported # 'testedwith' should be bytes, but not all extensions are ported
# to py3 and we don't want UnicodeException because of that. # to py3 and we don't want UnicodeException because of that.
testedwith = stringutil.forcebytestr( testedwith = stringutil.forcebytestr(
getattr(mod, 'testedwith', b'') getattr(mod, 'testedwith', b'')
) )
version = extensions.moduleversion(mod)
report = getattr(mod, 'buglink', _(b'the extension author.')) report = getattr(mod, 'buglink', _(b'the extension author.'))
if not testedwith.strip(): if not testedwith.strip():
# We found an untested extension. It's likely the culprit. # We found an untested extension. It's likely the culprit.
worst = name, b'unknown', report worst = name, b'unknown', report, version
break break
# Never blame on extensions bundled with Mercurial. # Never blame on extensions bundled with Mercurial.
if extensions.ismoduleinternal(mod): if extensions.ismoduleinternal(mod):
continue continue
tested = [util.versiontuple(t, 2) for t in testedwith.split()] tested = [util.versiontuple(t, 2) for t in testedwith.split()]
if ct in tested: if ct in tested:
continue continue
lower = [t for t in tested if t < ct] lower = [t for t in tested if t < ct]
nearest = max(lower or tested) nearest = max(lower or tested)
if worst[0] is None or nearest < worst[1]: if worst[0] is None or nearest < worst[1]:
worst = name, nearest, report worst = name, nearest, report, version
if worst[0] is not None: if worst[0] is not None:
name, testedwith, report = worst name, testedwith, report, version = worst
if not isinstance(testedwith, (bytes, str)): if not isinstance(testedwith, (bytes, str)):
testedwith = b'.'.join( testedwith = b'.'.join(
[stringutil.forcebytestr(c) for c in testedwith] [stringutil.forcebytestr(c) for c in testedwith]
) )
extver = version or _(b"(version N/A)")
warning = _( warning = _(
b'** Unknown exception encountered with ' b'** Unknown exception encountered with '
b'possibly-broken third-party extension %s\n' b'possibly-broken third-party extension %s %s\n'
b'** which supports versions %s of Mercurial.\n' b'** which supports versions %s of Mercurial.\n'
b'** Please disable %s and try your action again.\n' b'** Please disable %s and try your action again.\n'
b'** If that fixes the bug please report it to %s\n' b'** If that fixes the bug please report it to %s\n'
) % (name, testedwith, name, stringutil.forcebytestr(report)) ) % (name, extver, testedwith, name, stringutil.forcebytestr(report))
else: else:
bugtracker = ui.config(b'ui', b'supportcontact') bugtracker = ui.config(b'ui', b'supportcontact')
if bugtracker is None: if bugtracker is None:
bugtracker = _(b"https://mercurial-scm.org/wiki/BugTracker") bugtracker = _(b"https://mercurial-scm.org/wiki/BugTracker")
warning = ( warning = (
_( _(
b"** unknown exception encountered, " b"** unknown exception encountered, "
b"please report by visiting\n** " b"please report by visiting\n** "

tests/test-extension.t

Test extension without proper byteification of key attributes doesn't crash when Test extension without proper byteification of key attributes doesn't crash when
accessed. accessed.
$ hg version -v --config extensions.throw=throw.py | grep '^ ' $ hg version -v --config extensions.throw=throw.py | grep '^ '
throw external 1.0.0 throw external 1.0.0
No declared supported version, extension complains: No declared supported version, extension complains:
$ hg --config extensions.throw=throw.py throw 2>&1 | egrep '^\*\*' $ hg --config extensions.throw=throw.py throw 2>&1 | egrep '^\*\*'
** Unknown exception encountered with possibly-broken third-party extension throw ** Unknown exception encountered with possibly-broken third-party extension throw 1.0.0
** which supports versions unknown of Mercurial. ** which supports versions unknown of Mercurial.
** Please disable throw and try your action again. ** Please disable throw and try your action again.
** If that fixes the bug please report it to the extension author. ** If that fixes the bug please report it to the extension author.
** Python * (glob) ** Python * (glob)
** Mercurial Distributed SCM * (glob) ** Mercurial Distributed SCM * (glob)
** Extensions loaded: throw ** Extensions loaded: throw
empty declaration of supported version, extension complains (but doesn't choke if empty declaration of supported version, extension complains (but doesn't choke if
the value is improperly a str instead of bytes): the value is improperly a str instead of bytes):
$ echo "testedwith = ''" >> throw.py $ echo "testedwith = ''" >> throw.py
$ hg --config extensions.throw=throw.py throw 2>&1 | egrep '^\*\*' $ hg --config extensions.throw=throw.py throw 2>&1 | egrep '^\*\*'
** Unknown exception encountered with possibly-broken third-party extension throw ** Unknown exception encountered with possibly-broken third-party extension throw 1.0.0
** which supports versions unknown of Mercurial. ** which supports versions unknown of Mercurial.
** Please disable throw and try your action again. ** Please disable throw and try your action again.
** If that fixes the bug please report it to the extension author. ** If that fixes the bug please report it to the extension author.
** Python * (glob) ** Python * (glob)
** Mercurial Distributed SCM (*) (glob) ** Mercurial Distributed SCM (*) (glob)
** Extensions loaded: throw ** Extensions loaded: throw
If the extension specifies a buglink, show that (but don't choke if the value is If the extension specifies a buglink, show that (but don't choke if the value is
improperly a str instead of bytes): improperly a str instead of bytes):
$ echo 'buglink = "http://example.com/bts"' >> throw.py $ echo 'buglink = "http://example.com/bts"' >> throw.py
$ rm -f throw.pyc throw.pyo $ rm -f throw.pyc throw.pyo
$ rm -Rf __pycache__ $ rm -Rf __pycache__
$ hg --config extensions.throw=throw.py throw 2>&1 | egrep '^\*\*' $ hg --config extensions.throw=throw.py throw 2>&1 | egrep '^\*\*'
** Unknown exception encountered with possibly-broken third-party extension throw ** Unknown exception encountered with possibly-broken third-party extension throw 1.0.0
** which supports versions unknown of Mercurial. ** which supports versions unknown of Mercurial.
** Please disable throw and try your action again. ** Please disable throw and try your action again.
** If that fixes the bug please report it to http://example.com/bts ** If that fixes the bug please report it to http://example.com/bts
** Python * (glob) ** Python * (glob)
** Mercurial Distributed SCM (*) (glob) ** Mercurial Distributed SCM (*) (glob)
** Extensions loaded: throw ** Extensions loaded: throw
If the extensions declare outdated versions, accuse the older extension first: If the extensions declare outdated versions, accuse the older extension first:
$ echo "from mercurial import util" >> older.py $ echo "from mercurial import util" >> older.py
$ echo "util.version = lambda:b'2.2'" >> older.py $ echo "util.version = lambda:b'2.2'" >> older.py
$ echo "testedwith = b'1.9.3'" >> older.py $ echo "testedwith = b'1.9.3'" >> older.py
$ echo "testedwith = b'2.1.1'" >> throw.py $ echo "testedwith = b'2.1.1'" >> throw.py
$ rm -f throw.pyc throw.pyo $ rm -f throw.pyc throw.pyo
$ rm -Rf __pycache__ $ rm -Rf __pycache__
$ hg --config extensions.throw=throw.py --config extensions.older=older.py \ $ hg --config extensions.throw=throw.py --config extensions.older=older.py \
> throw 2>&1 | egrep '^\*\*' > throw 2>&1 | egrep '^\*\*'
** Unknown exception encountered with possibly-broken third-party extension older ** Unknown exception encountered with possibly-broken third-party extension older (version N/A)
** which supports versions 1.9 of Mercurial. ** which supports versions 1.9 of Mercurial.
** Please disable older and try your action again. ** Please disable older and try your action again.
** If that fixes the bug please report it to the extension author. ** If that fixes the bug please report it to the extension author.
** Python * (glob) ** Python * (glob)
** Mercurial Distributed SCM (version 2.2) ** Mercurial Distributed SCM (version 2.2)
** Extensions loaded: throw, older ** Extensions loaded: throw, older
One extension only tested with older, one only with newer versions: One extension only tested with older, one only with newer versions:
$ echo "util.version = lambda:b'2.1'" >> older.py $ echo "util.version = lambda:b'2.1'" >> older.py
$ rm -f older.pyc older.pyo $ rm -f older.pyc older.pyo
$ rm -Rf __pycache__ $ rm -Rf __pycache__
$ hg --config extensions.throw=throw.py --config extensions.older=older.py \ $ hg --config extensions.throw=throw.py --config extensions.older=older.py \
> throw 2>&1 | egrep '^\*\*' > throw 2>&1 | egrep '^\*\*'
** Unknown exception encountered with possibly-broken third-party extension older ** Unknown exception encountered with possibly-broken third-party extension older (version N/A)
** which supports versions 1.9 of Mercurial. ** which supports versions 1.9 of Mercurial.
** Please disable older and try your action again. ** Please disable older and try your action again.
** If that fixes the bug please report it to the extension author. ** If that fixes the bug please report it to the extension author.
** Python * (glob) ** Python * (glob)
** Mercurial Distributed SCM (version 2.1) ** Mercurial Distributed SCM (version 2.1)
** Extensions loaded: throw, older ** Extensions loaded: throw, older
Older extension is tested with current version, the other only with newer: Older extension is tested with current version, the other only with newer:
$ echo "util.version = lambda:b'1.9.3'" >> older.py $ echo "util.version = lambda:b'1.9.3'" >> older.py
$ rm -f older.pyc older.pyo $ rm -f older.pyc older.pyo
$ rm -Rf __pycache__ $ rm -Rf __pycache__
$ hg --config extensions.throw=throw.py --config extensions.older=older.py \ $ hg --config extensions.throw=throw.py --config extensions.older=older.py \
> throw 2>&1 | egrep '^\*\*' > throw 2>&1 | egrep '^\*\*'
** Unknown exception encountered with possibly-broken third-party extension throw ** Unknown exception encountered with possibly-broken third-party extension throw 1.0.0
** which supports versions 2.1 of Mercurial. ** which supports versions 2.1 of Mercurial.
** Please disable throw and try your action again. ** Please disable throw and try your action again.
** If that fixes the bug please report it to http://example.com/bts ** If that fixes the bug please report it to http://example.com/bts
** Python * (glob) ** Python * (glob)
** Mercurial Distributed SCM (version 1.9.3) ** Mercurial Distributed SCM (version 1.9.3)
** Extensions loaded: throw, older ** Extensions loaded: throw, older
Ability to point to a different point Ability to point to a different point