( )⚙ D2462 util: add a file object proxy that can notify observers

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D2462

util: add a file object proxy that can notify observers
ClosedPublic

Authored by indygreg on Feb 26 2018, 4:16 PM.

Details

Reviewers
durin42
Group Reviewers
hg-reviewers
Commits
rHGbfe38f787d5b: util: add a file object proxy that can notify observers
rHG72c27b55928c: util: add a file object proxy that can notify observers
Summary

There are various places in Mercurial where we may want to
instrument low-level I/O. The use cases I can think of all
involve development-type activities like monitoring the raw
bytes passing through a file (for testing and debugging),
counting the number of I/O function calls (for performance
monitoring), and changing the behavior of I/O function calls
(e.g. simulating a failure) (to facilitate testing).

This commit invents a mechanism to wrap a file object so we
can observe activity on it. We have similar functionality in
badserverext.py. But that's a test-only extension and is pretty
specific to the HTTP server. I would like a mechanism in core
that is sufficiently generic so it can be used by multiple
consumers, including hg debug* commands.

The added code consists of a proxy type for file objects.
It is bound to an "observer," which receives callbacks whenever
I/O methods are called.

We also add an implementation of an observer that logs specific
I/O events. This observer will be used in an upcoming commit
to record low-level wire protocol activity.

A helper function to convert a file object into an observed
file object has also been implemented.

I don't anticipate any critical functionality in core using
these types. So I don't think explicit test coverage is
worth implementing.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

indygreg created this revision.Feb 26 2018, 4:16 PM
lothiraldan added a subscriber: lothiraldan.Feb 27 2018, 5:50 AM
lothiraldan added inline comments.
mercurial/util.py
535

Could we define the ours set at the class level so an extension/subclass could easily update it if needed?

indygreg added inline comments.Feb 27 2018, 4:46 PM
mercurial/util.py
535

That's a good idea. I can do it as a follow-up. There are already a ton of commits in this series and I want to avoid more churn.

durin42 accepted this revision.Mar 1 2018, 4:13 PM
This revision is now accepted and ready to land.Mar 1 2018, 4:13 PM
Closed by commit rHG72c27b55928c: util: add a file object proxy that can notify observers (authored by indygreg). · Explain WhyMar 1 2018, 4:30 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/util.py (222 lines)

Diff 6135

mercurial/util.py

p = subprocess.Popen(cmd, shell=True, bufsize=bufsize, p = subprocess.Popen(cmd, shell=True, bufsize=bufsize,
close_fds=closefds, close_fds=closefds,
stdin=subprocess.PIPE, stdout=subprocess.PIPE, stdin=subprocess.PIPE, stdout=subprocess.PIPE,
stderr=subprocess.PIPE, stderr=subprocess.PIPE,
universal_newlines=newlines, universal_newlines=newlines,
env=env) env=env)
return p.stdin, p.stdout, p.stderr, p return p.stdin, p.stdout, p.stderr, p
class fileobjectproxy(object):
"""A proxy around file objects that tells a watcher when events occur.
This type is intended to only be used for testing purposes. Think hard
before using it in important code.
"""
__slots__ = (
'_orig',
'_observer',
)
def __init__(self, fh, observer):
object.__setattr__(self, '_orig', fh)
object.__setattr__(self, '_observer', observer)
def __getattribute__(self, name):
ours = {
# IOBase
r'close',
# closed if a property
r'fileno',
r'flush',
r'isatty',
r'readable',
r'readline',
r'readlines',
r'seek',
r'seekable',
r'tell',
r'truncate',
r'writable',
r'writelines',
# RawIOBase
r'read',
r'readall',
r'readinto',
r'write',
# BufferedIOBase
# raw is a property
r'detach',
# read defined above
r'read1',
# readinto defined above
# write defined above
}
lothiraldanUnsubmitted
Not Done

Could we define the ours set at the class level so an extension/subclass could easily update it if needed?

lothiraldan: Could we define the `ours` set at the class level so an extension/subclass could easily update…
indygregAuthorUnsubmitted
Not Done

That's a good idea. I can do it as a follow-up. There are already a ton of commits in this series and I want to avoid more churn.

indygreg: That's a good idea. I can do it as a follow-up. There are already a ton of commits in this…
# We only observe some methods.
if name in ours:
return object.__getattribute__(self, name)
return getattr(object.__getattribute__(self, r'_orig'), name)
def __delattr__(self, name):
return delattr(object.__getattribute__(self, r'_orig'), name)
def __setattr__(self, name, value):
return setattr(object.__getattribute__(self, r'_orig'), name, value)
def __iter__(self):
return object.__getattribute__(self, r'_orig').__iter__()
def _observedcall(self, name, *args, **kwargs):
# Call the original object.
orig = object.__getattribute__(self, r'_orig')
res = getattr(orig, name)(*args, **kwargs)
# Call a method on the observer of the same name with arguments
# so it can react, log, etc.
observer = object.__getattribute__(self, r'_observer')
fn = getattr(observer, name, None)
if fn:
fn(res, *args, **kwargs)
return res
def close(self, *args, **kwargs):
return object.__getattribute__(self, r'_observedcall')(
r'close', *args, **kwargs)
def fileno(self, *args, **kwargs):
return object.__getattribute__(self, r'_observedcall')(
r'fileno', *args, **kwargs)
def flush(self, *args, **kwargs):
return object.__getattribute__(self, r'_observedcall')(
r'flush', *args, **kwargs)
def isatty(self, *args, **kwargs):
return object.__getattribute__(self, r'_observedcall')(
r'isatty', *args, **kwargs)
def readable(self, *args, **kwargs):
return object.__getattribute__(self, r'_observedcall')(
r'readable', *args, **kwargs)
def readline(self, *args, **kwargs):
return object.__getattribute__(self, r'_observedcall')(
r'readline', *args, **kwargs)
def readlines(self, *args, **kwargs):
return object.__getattribute__(self, r'_observedcall')(
r'readlines', *args, **kwargs)
def seek(self, *args, **kwargs):
return object.__getattribute__(self, r'_observedcall')(
r'seek', *args, **kwargs)
def seekable(self, *args, **kwargs):
return object.__getattribute__(self, r'_observedcall')(
r'seekable', *args, **kwargs)
def tell(self, *args, **kwargs):
return object.__getattribute__(self, r'_observedcall')(
r'tell', *args, **kwargs)
def truncate(self, *args, **kwargs):
return object.__getattribute__(self, r'_observedcall')(
r'truncate', *args, **kwargs)
def writable(self, *args, **kwargs):
return object.__getattribute__(self, r'_observedcall')(
r'writable', *args, **kwargs)
def writelines(self, *args, **kwargs):
return object.__getattribute__(self, r'_observedcall')(
r'writelines', *args, **kwargs)
def read(self, *args, **kwargs):
return object.__getattribute__(self, r'_observedcall')(
r'read', *args, **kwargs)
def readall(self, *args, **kwargs):
return object.__getattribute__(self, r'_observedcall')(
r'readall', *args, **kwargs)
def readinto(self, *args, **kwargs):
return object.__getattribute__(self, r'_observedcall')(
r'readinto', *args, **kwargs)
def write(self, *args, **kwargs):
return object.__getattribute__(self, r'_observedcall')(
r'write', *args, **kwargs)
def detach(self, *args, **kwargs):
return object.__getattribute__(self, r'_observedcall')(
r'detach', *args, **kwargs)
def read1(self, *args, **kwargs):
return object.__getattribute__(self, r'_observedcall')(
r'read1', *args, **kwargs)
DATA_ESCAPE_MAP = {pycompat.bytechr(i): br'\x%02x' % i for i in range(256)}
DATA_ESCAPE_MAP.update({
b'\\': b'\\\\',
b'\r': br'\r',
b'\n': br'\n',
})
DATA_ESCAPE_RE = remod.compile(br'[\x00-\x08\x0a-\x1f\\\x7f-\xff]')
def escapedata(s):
return DATA_ESCAPE_RE.sub(lambda m: DATA_ESCAPE_MAP[m.group(0)], s)
class fileobjectobserver(object):
"""Logs file object activity."""
def __init__(self, fh, name, reads=True, writes=True, logdata=False):
self.fh = fh
self.name = name
self.logdata = logdata
self.reads = reads
self.writes = writes
def _writedata(self, data):
if not self.logdata:
self.fh.write('\n')
return
# Simple case writes all data on a single line.
if b'\n' not in data:
self.fh.write(': %s\n' % escapedata(data))
return
# Data with newlines is written to multiple lines.
self.fh.write(':\n')
lines = data.splitlines(True)
for line in lines:
self.fh.write('%s> %s\n' % (self.name, escapedata(line)))
def read(self, res, size=-1):
if not self.reads:
return
self.fh.write('%s> read(%d) -> %d' % (self.name, size, len(res)))
self._writedata(res)
def readline(self, res, limit=-1):
if not self.reads:
return
self.fh.write('%s> readline() -> %d' % (self.name, len(res)))
self._writedata(res)
def write(self, res, data):
if not self.writes:
return
self.fh.write('%s> write(%d) -> %r' % (self.name, len(data), res))
self._writedata(data)
def flush(self, res):
if not self.writes:
return
self.fh.write('%s> flush() -> %r\n' % (self.name, res))
def makeloggingfileobject(logh, fh, name, reads=True, writes=True,
logdata=False):
"""Turn a file object into a logging file object."""
observer = fileobjectobserver(logh, name, reads=reads, writes=writes,
logdata=logdata)
return fileobjectproxy(fh, observer)
def version(): def version():
"""Return version information if available.""" """Return version information if available."""
try: try:
from . import __version__ from . import __version__
return __version__.version return __version__.version
except ImportError: except ImportError:
return 'unknown' return 'unknown'