mirror of
https://github.com/facebook/sapling.git
synced 2024-10-11 09:17:30 +03:00
d7c143274c
Summary: Add a new extension to assist with debugging issues with the inhibit extension. Adds the `hg debuginhibit` and `hg debugdeinhibit` commands to manually inhibit/deinhibit commits as well as config options to print out the nodes being inhibited and truncated stack traces of each call site. I mostly made this into an extension so that it would be easy to debug inhibit issues from any user by just asking them to run their command with the appropriate `--config` flag. Test Plan: See test file. Enabling the `debuginhibit.printnodes` and `debuginhibit.printstack` functions should result in the relevant nodes and stack traces to be printed whenever nodes are inhibited and deinhibited. Reviewers: durham, rmcelroy, #mercurial, mitrandir, simonfar Reviewed By: simonfar Subscribers: mitrandir, mjpieters Differential Revision: https://phabricator.intern.facebook.com/D4485659 Signature: t1:4485659:1485985964:e6920b67450942c706c9523e9df48b4093b26d69
126 lines
3.9 KiB
Python
126 lines
3.9 KiB
Python
# debuginhibit.py
|
|
#
|
|
# Copyright 2017 Facebook, Inc.
|
|
#
|
|
# This software may be used and distributed according to the terms of the
|
|
# GNU General Public License version 2 or any later version.
|
|
|
|
"""debug commands and instrumentation for the inhibit extension
|
|
|
|
Adds the `debuginhibit` and `debugdeinhibit` commands to manually inhibit
|
|
and deinhibit nodes for testing purposes. Also causes inhibit to print
|
|
out the nodes being inhihibited or deinhibited and/or a stack trace of each
|
|
call site with the following config options::
|
|
|
|
[debuginhibit]
|
|
printnodes = true
|
|
printstack = true
|
|
stackdepth = 4
|
|
|
|
If stackdepth is not specified, a full stack trace will be printed.
|
|
"""
|
|
|
|
import inspect
|
|
import os
|
|
|
|
from contextlib import nested
|
|
from functools import partial
|
|
from operator import itemgetter
|
|
|
|
from mercurial import (
|
|
cmdutil,
|
|
extensions,
|
|
error,
|
|
scmutil,
|
|
)
|
|
from mercurial.i18n import _
|
|
from mercurial.node import short
|
|
|
|
testedwith = 'ships-with-fb-hgext'
|
|
|
|
cmdtable = {}
|
|
command = cmdutil.command(cmdtable)
|
|
|
|
inhibit = None
|
|
|
|
def extsetup(ui):
|
|
global inhibit
|
|
try:
|
|
inhibit = extensions.find('inhibit')
|
|
except KeyError:
|
|
ui.warn(_("no inhibit extension detected - disabling debuginhibit"))
|
|
return
|
|
|
|
if ui.configbool('debuginhibit', 'printnodes'):
|
|
extensions.wrapfunction(
|
|
inhibit,
|
|
'_inhibitmarkers',
|
|
partial(printnodes, ui, label="Inhibiting")
|
|
)
|
|
extensions.wrapfunction(
|
|
inhibit,
|
|
'_deinhibitmarkers',
|
|
partial(printnodes, ui, label="Deinhibiting")
|
|
)
|
|
|
|
def printnodes(ui, orig, repo, nodes, label=None):
|
|
"""Print out the nodes being inhibited/dehinhibited."""
|
|
if label is None:
|
|
label = "Nodes"
|
|
|
|
# `nodes` may be a generator, so collect it into a list first.
|
|
nodes = list(nodes)
|
|
ui.status(_("%s: %s\n") % (label, [short(n) for n in nodes]))
|
|
|
|
# Print out a truncated stack trace at the callsite if specified.
|
|
if ui.configbool('debuginhibit', 'printstack'):
|
|
trace = [_printframe(fi) for fi in inspect.stack()]
|
|
|
|
# Truncate the stack trace is specified by the user's config.
|
|
# Always remove the first two entries since they correspond
|
|
# to this wrapper function.
|
|
depth = ui.config('debuginhibit', 'stackdepth')
|
|
trace = trace[2:] if depth is None else trace[2:2 + int(depth)]
|
|
|
|
ui.status(_("Context:\n\t%s\n") % "\n\t".join(trace))
|
|
|
|
return orig(repo, nodes)
|
|
|
|
@command('debuginhibit', [
|
|
('r', 'rev', [], _("revisions to inhibit or deinhibit")),
|
|
('d', 'deinhibit', False, _("deinhibit the specified revs"))
|
|
])
|
|
def debuginhibit(ui, repo, *revs, **opts):
|
|
"""manually inhibit or deinhibit the specified revisions
|
|
|
|
By default inhibits any obsolescence markers on the given revs.
|
|
"""
|
|
_checkenabled(repo)
|
|
|
|
revs = list(revs) + opts.get('rev', [])
|
|
revs = scmutil.revrange(repo, revs)
|
|
nodes = (repo.changelog.node(rev) for rev in revs)
|
|
|
|
with nested(repo.wlock(), repo.lock()):
|
|
with repo.transaction('debuginhibit') as tr:
|
|
if opts.get('deinhibit', False):
|
|
inhibit._deinhibitmarkers(repo, nodes)
|
|
else:
|
|
inhibit._inhibitmarkers(repo, nodes)
|
|
|
|
# Disable inhibit's post-transaction callback so that we only
|
|
# affect the changesets specified by the user.
|
|
del tr._postclosecallback['inhibitposttransaction']
|
|
|
|
def _printframe(frameinfo):
|
|
"""Return a human-readable string representation of a FrameInfo object."""
|
|
path, line, fn = itemgetter(1, 2, 3)(frameinfo)
|
|
return "[%s:%d] %s()" % (os.path.basename(path), line, fn)
|
|
|
|
def _checkenabled(repo):
|
|
"""Abort if inhibit is unavailable or disabled."""
|
|
if inhibit is None:
|
|
raise error.Abort(_("no inhibit extension detected"))
|
|
if not inhibit._inhibitenabled(repo):
|
|
raise error.Abort(_("inhibit extension is present but disabled"))
|