( )⚙ D7187 py3: fix fsmonitor error message formatting under Python3

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D7187

py3: fix fsmonitor error message formatting under Python3
Needs RevisionPublic

Authored by touilleMan on Nov 1 2019, 12:14 PM.

Details

Reviewers
indygreg
Group Reviewers
hg-reviewers
Summary

The watchmanclient.Unavailable exception got an invalid str
method resulting in a crash when watchman is not available.
This fix also solve tests/test-install.t.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

touilleMan created this revision.Nov 1 2019, 12:14 PM
touilleMan updated this revision to Diff 17435.Nov 1 2019, 12:16 PM
indygreg requested changes to this revision.Nov 1 2019, 1:22 PM
indygreg added a subscriber: indygreg.
indygreg added inline comments.
hgext/fsmonitor/watchmanclient.py
26

There's no __bytes__ on Python 2. So we'll want to preserve an implementation for Python 2.

This is typically something like __str__ = encoding.strmethod(__bytes__)

This revision now requires changes to proceed.Nov 1 2019, 1:22 PM

Revision Contents
Changeset List

Diff 17435

hgext/fsmonitor/__init__.py

merge, merge,
pathutil, pathutil,
pycompat, pycompat,
registrar, registrar,
scmutil, scmutil,
util, util,
) )
from mercurial import match as matchmod from mercurial import match as matchmod
from mercurial.utils.stringutil import forcebytestr
from . import ( from . import (
pywatchman, pywatchman,
state, state,
watchmanclient, watchmanclient,
) )
# Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for
try: try:
v = c.command(b"version") v = c.command(b"version")
fm.write( fm.write(
b"fsmonitor-watchman-version", b"fsmonitor-watchman-version",
_(b" watchman binary version %s\n"), _(b" watchman binary version %s\n"),
v[b"version"], v[b"version"],
) )
except watchmanclient.Unavailable as e: except watchmanclient.Unavailable as e:
err = str(e) err = forcebytestr(e)
fm.condwrite( fm.condwrite(
err, err,
b"fsmonitor-watchman-error", b"fsmonitor-watchman-error",
_(b" watchman binary missing or broken: %s\n"), _(b" watchman binary missing or broken: %s\n"),
err, err,
) )
return 1 if err else 0 return 1 if err else 0

hgext/fsmonitor/watchmanclient.py

# watchmanclient.py - Watchman client for the fsmonitor extension # watchmanclient.py - Watchman client for the fsmonitor extension
# #
# Copyright 2013-2016 Facebook, Inc. # Copyright 2013-2016 Facebook, Inc.
# #
# This software may be used and distributed according to the terms of the # This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version. # GNU General Public License version 2 or any later version.
from __future__ import absolute_import from __future__ import absolute_import
import getpass import getpass
from mercurial import util from mercurial import util
from mercurial.utils.stringutil import forcebytestr
from . import pywatchman from . import pywatchman
class Unavailable(Exception): class Unavailable(Exception):
def __init__(self, msg, warn=True, invalidate=False): def __init__(self, msg, warn=True, invalidate=False):
self.msg = msg self.msg = msg
self.warn = warn self.warn = warn
if self.msg == b'timed out waiting for response': if self.msg == b'timed out waiting for response':
self.warn = False self.warn = False
self.invalidate = invalidate self.invalidate = invalidate
def __str__(self): def __bytes__(self):
indygregUnsubmitted
Not Done

There's no __bytes__ on Python 2. So we'll want to preserve an implementation for Python 2.

This is typically something like __str__ = encoding.strmethod(__bytes__)

indygreg: There's no `__bytes__` on Python 2. So we'll want to preserve an implementation for Python 2.
if self.warn: if self.warn:
return b'warning: Watchman unavailable: %s' % self.msg return b'warning: Watchman unavailable: %s' % self.msg
else: else:
return b'Watchman unavailable: %s' % self.msg return b'Watchman unavailable: %s' % self.msg
class WatchmanNoRoot(Unavailable): class WatchmanNoRoot(Unavailable):
def __init__(self, root, msg): def __init__(self, root, msg):
watchman_exe=watchman_exe, watchman_exe=watchman_exe,
) )
return self._watchmanclient.query(*watchmanargs) return self._watchmanclient.query(*watchmanargs)
except pywatchman.CommandError as ex: except pywatchman.CommandError as ex:
if b'unable to resolve root' in ex.msg: if b'unable to resolve root' in ex.msg:
raise WatchmanNoRoot(self._root, ex.msg) raise WatchmanNoRoot(self._root, ex.msg)
raise Unavailable(ex.msg) raise Unavailable(ex.msg)
except pywatchman.WatchmanError as ex: except pywatchman.WatchmanError as ex:
raise Unavailable(str(ex)) raise Unavailable(forcebytestr(ex))
def command(self, *args): def command(self, *args):
try: try:
try: try:
return self._command(*args) return self._command(*args)
except WatchmanNoRoot: except WatchmanNoRoot:
# this 'watch' command can also raise a WatchmanNoRoot if # this 'watch' command can also raise a WatchmanNoRoot if
# watchman refuses to accept this root # watchman refuses to accept this root
self._command(b'watch') self._command(b'watch')
return self._command(*args) return self._command(*args)
except Unavailable: except Unavailable:
# this is in an outer scope to catch Unavailable form any of the # this is in an outer scope to catch Unavailable form any of the
# above _command calls # above _command calls
self._watchmanclient = None self._watchmanclient = None
raise raise