( )⚙ D9433 extensions: avoid a crash when the version isn't properly byteified on py3

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D9433

extensions: avoid a crash when the version isn't properly byteified on py3
ClosedPublic

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

Details

Reviewers
pulkit
Group Reviewers
hg-reviewers
Commits
rHG27c23c8f14da: extensions: avoid a crash when the version isn't properly byteified on py3
rHG3db545fccac1: extensions: avoid a crash when the version isn't properly byteified on py3
Summary

We already force bytestr on the testedwith and buglink attributes in
dispatch.py when generating a bug report with a similar comment about not
every extension being ported to py3. We should do the same here, so the
function can be properly typed.

Diff Detail

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

Revision Contents
Changeset List

PathPackages
Mmercurial/extensions.py (4 lines)
Mtests/test-extension.t (8 lines)

Diff 23753

mercurial/extensions.py

if util.safehasattr(module, b'getversion') and callable(module.getversion): if util.safehasattr(module, b'getversion') and callable(module.getversion):
version = module.getversion() version = module.getversion()
elif util.safehasattr(module, b'__version__'): elif util.safehasattr(module, b'__version__'):
version = module.__version__ version = module.__version__
else: else:
version = b'' version = b''
if isinstance(version, (list, tuple)): if isinstance(version, (list, tuple)):
version = b'.'.join(pycompat.bytestr(o) for o in version) version = b'.'.join(pycompat.bytestr(o) for o in version)
else:
# version data should be bytes, but not all extensions are ported
# to py3.
version = stringutil.forcebytestr(version)
return version return version
def ismoduleinternal(module): def ismoduleinternal(module):
exttestedwith = getattr(module, 'testedwith', None) exttestedwith = getattr(module, 'testedwith', None)
return exttestedwith == b"ships-with-hg-core" return exttestedwith == b"ships-with-hg-core"

tests/test-extension.t

(try 'hg help --keyword foo') (try 'hg help --keyword foo')
[255] [255]
$ cat > throw.py <<EOF $ cat > throw.py <<EOF
> from mercurial import commands, registrar, util > from mercurial import commands, registrar, util
> cmdtable = {} > cmdtable = {}
> command = registrar.command(cmdtable) > command = registrar.command(cmdtable)
> class Bogon(Exception): pass > class Bogon(Exception): pass
> # NB: version should be bytes; simulating extension not ported to py3
> __version__ = '1.0.0'
> @command(b'throw', [], b'hg throw', norepo=True) > @command(b'throw', [], b'hg throw', norepo=True)
> def throw(ui, **opts): > def throw(ui, **opts):
> """throws an exception""" > """throws an exception"""
> raise Bogon() > raise Bogon()
> EOF > EOF
Test extension without proper byteification of key attributes doesn't crash when
accessed.
$ hg version -v --config extensions.throw=throw.py | grep '^ '
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
** 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)