( )⚙ D1164 extensions: always include traceback when extension setup fails

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D1164

extensions: always include traceback when extension setup fails
ClosedPublic

Authored by martinvonz on Oct 17 2017, 2:24 PM.

Details

Reviewers
quark
Group Reviewers
hg-reviewers
Commits
rHG78d9a7b7cdb6: extensions: always include traceback when extension setup fails
Summary

I have spent a lot of time debugging extensions that failed to load
because we don't include a traceback and I didn't realize I could get
traceback for the extension failure with --traceback. Let's just turn
them on by default, since it should be rare that the user sees these
tracebacks anyway (and if they do, it's not so bad if the extra
traceback pushes them a little harder to report the problem).

Since we already had a test case with --traceback and one without, I
just removed the one with the flag.

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

martinvonz created this revision.Oct 17 2017, 2:24 PM
quark accepted this revision.Oct 17 2017, 7:37 PM
Closed by commit rHG78d9a7b7cdb6: extensions: always include traceback when extension setup fails (authored by martinvonz). · Explain WhyOct 18 2017, 8:47 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 2974

mercurial/extensions.py

return mod return mod
def _runuisetup(name, ui): def _runuisetup(name, ui):
uisetup = getattr(_extensions[name], 'uisetup', None) uisetup = getattr(_extensions[name], 'uisetup', None)
if uisetup: if uisetup:
try: try:
uisetup(ui) uisetup(ui)
except Exception as inst: except Exception as inst:
ui.traceback() ui.traceback(force=True)
msg = util.forcebytestr(inst) msg = util.forcebytestr(inst)
ui.warn(_("*** failed to set up extension %s: %s\n") % (name, msg)) ui.warn(_("*** failed to set up extension %s: %s\n") % (name, msg))
return False return False
return True return True
def _runextsetup(name, ui): def _runextsetup(name, ui):
extsetup = getattr(_extensions[name], 'extsetup', None) extsetup = getattr(_extensions[name], 'extsetup', None)
if extsetup: if extsetup:
try: try:
try: try:
extsetup(ui) extsetup(ui)
except TypeError: except TypeError:
# Try to use getfullargspec (Python 3) first, and fall # Try to use getfullargspec (Python 3) first, and fall
# back to getargspec only if it doesn't exist so as to # back to getargspec only if it doesn't exist so as to
# avoid warnings. # avoid warnings.
if getattr(inspect, 'getfullargspec', if getattr(inspect, 'getfullargspec',
getattr(inspect, 'getargspec'))(extsetup).args: getattr(inspect, 'getargspec'))(extsetup).args:
raise raise
extsetup() # old extsetup with no ui argument extsetup() # old extsetup with no ui argument
except Exception as inst: except Exception as inst:
ui.traceback() ui.traceback(force=True)
msg = util.forcebytestr(inst) msg = util.forcebytestr(inst)
ui.warn(_("*** failed to set up extension %s: %s\n") % (name, msg)) ui.warn(_("*** failed to set up extension %s: %s\n") % (name, msg))
return False return False
return True return True
def loadall(ui, whitelist=None): def loadall(ui, whitelist=None):
result = ui.configitems("extensions") result = ui.configitems("extensions")
if whitelist is not None: if whitelist is not None:

tests/test-extension.t

Make sure a broken uisetup doesn't globally break hg: Make sure a broken uisetup doesn't globally break hg:
$ cat > $TESTTMP/baduisetup.py <<EOF $ cat > $TESTTMP/baduisetup.py <<EOF
> def uisetup(ui): > def uisetup(ui):
> 1/0 > 1/0
> EOF > EOF
Even though the extension fails during uisetup, hg is still basically usable: Even though the extension fails during uisetup, hg is still basically usable:
$ hg --config extensions.baduisetup=$TESTTMP/baduisetup.py version $ hg --config extensions.baduisetup=$TESTTMP/baduisetup.py version
*** failed to set up extension baduisetup: integer division or modulo by zero
Mercurial Distributed SCM (version *) (glob)
(see https://mercurial-scm.org for more information)
Copyright (C) 2005-2017 Matt Mackall and others
This is free software; see the source for copying conditions. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
$ hg --config extensions.baduisetup=$TESTTMP/baduisetup.py version --traceback
Traceback (most recent call last): Traceback (most recent call last):
File "*/mercurial/extensions.py", line *, in _runuisetup (glob) File "*/mercurial/extensions.py", line *, in _runuisetup (glob)
uisetup(ui) uisetup(ui)
File "$TESTTMP/baduisetup.py", line 2, in uisetup File "$TESTTMP/baduisetup.py", line 2, in uisetup
1/0 1/0
ZeroDivisionError: integer division or modulo by zero ZeroDivisionError: integer division or modulo by zero
*** failed to set up extension baduisetup: integer division or modulo by zero *** failed to set up extension baduisetup: integer division or modulo by zero
Mercurial Distributed SCM (version *) (glob) Mercurial Distributed SCM (version *) (glob)

tests/test-flagprocessor.t

# TEST: ensure we cannot register several flag processors on the same flag # TEST: ensure we cannot register several flag processors on the same flag
$ cat >> .hg/hgrc << EOF $ cat >> .hg/hgrc << EOF
> [extensions] > [extensions]
> extension=$TESTDIR/flagprocessorext.py > extension=$TESTDIR/flagprocessorext.py
> duplicate=$TESTDIR/flagprocessorext.py > duplicate=$TESTDIR/flagprocessorext.py
> EOF > EOF
$ hg debugrebuilddirstate $ hg debugrebuilddirstate
Traceback (most recent call last):
File "*/mercurial/extensions.py", line *, in _runextsetup (glob)
extsetup(ui)
File "*/tests/flagprocessorext.py", line *, in extsetup (glob)
validatehash,
File "*/mercurial/revlog.py", line *, in addflagprocessor (glob)
raise error.Abort(msg)
Abort: cannot register multiple processors on flag '0x8'.
*** failed to set up extension duplicate: cannot register multiple processors on flag '0x8'. *** failed to set up extension duplicate: cannot register multiple processors on flag '0x8'.
$ hg st 2>&1 | egrep 'cannot register multiple processors|flagprocessorext' $ hg st 2>&1 | egrep 'cannot register multiple processors|flagprocessorext'
File "*/tests/flagprocessorext.py", line *, in extsetup (glob)
Abort: cannot register multiple processors on flag '0x8'.
*** failed to set up extension duplicate: cannot register multiple processors on flag '0x8'. *** failed to set up extension duplicate: cannot register multiple processors on flag '0x8'.
File "*/tests/flagprocessorext.py", line *, in b64decode (glob) File "*/tests/flagprocessorext.py", line *, in b64decode (glob)
$ cd .. $ cd ..
# TEST: bundle repo # TEST: bundle repo
$ hg init bundletest $ hg init bundletest
$ cd bundletest $ cd bundletest