sapling/hgext3rd/fbamend.py
Arun Kulshreshtha 0943b06da1 fbamend: add config option to use restack instead of preamend bookmark
Summary: Added a configuration option to make fbamend use the functionality from `hg rebase --restack` instead of the previous bookmark-based approach in `hg amend`.

Test Plan: Enable the `fbamend.userestack` config option and attempt to use `hg amend`, `hg amend --fixup`, and `hg amend --rebase`. These should all work just as before, except that `hg amend` will no longer create .preamend bookmarks.

Reviewers: #sourcecontrol, quark, durham

Reviewed By: durham

Subscribers: mjpieters

Differential Revision: https://phabricator.intern.facebook.com/D4062925

Tasks: 13839177

Signature: t1:4062925:1477359251:0ece10599987d6b8e39384e9530866ffb2e50e58
2016-10-25 11:10:47 -07:00

789 lines
28 KiB
Python

# fbamend.py - improved amend functionality
#
# Copyright 2013 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.
"""extends the existing commit amend functionality
Adds an hg amend command that amends the current parent changeset with the
changes in the working copy. Similiar to the existing hg commit --amend
except it doesn't prompt for the commit message unless --edit is provided.
Allows amending changesets that have children and can automatically rebase
the children onto the new version of the changeset.
This extension is incompatible with changeset evolution. The command will
automatically disable itself if changeset evolution is enabled.
To disable the creation of preamend bookmarks and use obsolescence
markers instead to fix up amends, enable the following config option::
[fbamend]
userestack=true
"""
from mercurial import (
bookmarks,
cmdutil,
commands,
error,
extensions,
merge,
obsolete,
phases,
repair,
)
from mercurial.node import hex, nullrev
from mercurial import lock as lockmod
from mercurial.i18n import _
from collections import defaultdict, deque
from contextlib import nested
cmdtable = {}
command = cmdutil.command(cmdtable)
testedwith = 'internal'
rebasemod = None
inhibitmod = None
amendopts = [
('', 'rebase', None, _('rebases children after the amend')),
('', 'fixup', None, _('rebase children from a previous amend')),
]
def uisetup(ui):
global rebasemod
try:
rebasemod = extensions.find('rebase')
except KeyError:
ui.warn(_("no rebase extension detected - disabling fbamend"))
return
entry = extensions.wrapcommand(commands.table, 'commit', commit)
for opt in amendopts:
opt = (opt[0], opt[1], opt[2], "(with --amend) " + opt[3])
entry[1].append(opt)
# manual call of the decorator
command('^amend', [
('A', 'addremove', None,
_('mark new/missing files as added/removed before committing')),
('e', 'edit', None, _('prompt to edit the commit message')),
('i', 'interactive', None, _('use interactive mode')),
] + amendopts + commands.walkopts + commands.commitopts,
_('hg amend [OPTION]...'))(amend)
command('^unamend', [])(unamend)
def has_automv(loaded):
if not loaded:
return
automv = extensions.find('automv')
entry = extensions.wrapcommand(cmdtable, 'amend', automv.mvcheck)
entry[1].append(
('', 'no-move-detection', None,
_('disable automatic file move detection')))
extensions.afterloaded('automv', has_automv)
# If the evolve extension is enabled, wrap the `next` command to
# add the --rebase flag.
def wrapnext(loaded):
if not loaded:
return
global inhibitmod
try:
inhibitmod = extensions.find('inhibit')
except KeyError:
pass
evolvemod = extensions.find('evolve')
entry = extensions.wrapcommand(evolvemod.cmdtable, 'next', nextrebase)
entry[1].append((
'', 'rebase', False, _('rebase the changeset if necessary')
))
extensions.afterloaded('evolve', wrapnext)
def wraprebase(loaded):
if not loaded:
return
entry = extensions.wrapcommand(rebasemod.cmdtable, 'rebase',
rebaserestack)
entry[1].append((
'', 'restack', False, _('rebase all changesets in the current '
'stack onto the latest version of their '
'respective parents')
))
extensions.afterloaded('rebase', wraprebase)
def commit(orig, ui, repo, *pats, **opts):
if opts.get("amend"):
# commit --amend default behavior is to prompt for edit
opts['noeditmessage'] = True
return amend(ui, repo, *pats, **opts)
else:
badflags = [flag for flag in
['rebase', 'fixup'] if opts.get(flag, None)]
if badflags:
raise error.Abort(_('--%s must be called with --amend') %
badflags[0])
return orig(ui, repo, *pats, **opts)
def unamend(ui, repo, **opts):
"""undo the amend operation on a current changeset
This command will roll back to the previous version of a changeset,
leaving working directory in state in which it was before running
`hg amend` (e.g. files modified as part of an amend will be
marked as modified `hg status`)"""
try:
inhibitmod = extensions.find('inhibit')
except KeyError:
hint = _("please add inhibit to the list of enabled extensions")
e = _("unamend requires inhibit extension to be enabled")
raise error.Abort(e, hint=hint)
unfi = repo.unfiltered()
# identify the commit from which to unamend
curctx = repo['.']
# identify the commit to which to unamend
markers = list(obsolete.precursormarkers(curctx))
if len(markers) != 1:
e = _("changeset must have one precursor, found %i precursors")
raise error.Abort(e % len(markers))
precnode = markers[0].precnode()
precctx = unfi[precnode]
if curctx.children():
raise error.Abort(_("cannot unamend in the middle of a stack"))
with nested(repo.wlock(), repo.lock()):
repobookmarks = repo._bookmarks
ctxbookmarks = curctx.bookmarks()
# we want to inhibit markers that mark precnode obsolete
inhibitmod._inhibitmarkers(unfi, [precnode])
changedfiles = []
wctx = repo[None]
wm = wctx.manifest()
cm = precctx.manifest()
dirstate = repo.dirstate
diff = cm.diff(wm)
changedfiles.extend(diff.iterkeys())
tr = repo.transaction('unamend')
dirstate.beginparentchange()
dirstate.rebuild(precnode, cm, changedfiles)
# we want added and removed files to be shown
# properly, not with ? and ! prefixes
for filename, data in diff.iteritems():
if data[0][0] is None:
dirstate.add(filename)
if data[1][0] is None:
dirstate.remove(filename)
dirstate.endparentchange()
for book in ctxbookmarks:
repobookmarks[book] = precnode
repobookmarks.recordchange(tr)
tr.close()
# we want to mark the changeset from which we were unamending
# as obsolete
obsolete.createmarkers(repo, [(curctx, ())])
def amend(ui, repo, *pats, **opts):
'''amend the current changeset with more changes
'''
if obsolete.isenabled(repo, 'allnewcommands'):
msg = ('fbamend and evolve extension are incompatible, '
'fbamend deactivated.\n'
'You can either disable it globally:\n'
'- type `hg config --edit`\n'
'- drop the `fbamend=` line from the `[extensions]` section\n'
'or disable it for a specific repo:\n'
'- type `hg config --local --edit`\n'
'- add a `fbamend=!%s` line in the `[extensions]` section\n')
msg %= ui.config('extensions', 'fbamend')
ui.write_err(msg)
rebase = opts.get('rebase')
if rebase and _histediting(repo):
# if a histedit is in flight, it's dangerous to remove old commits
hint = _('during histedit, use amend without --rebase')
raise error.Abort('histedit in progress', hint=hint)
badflags = [flag for flag in
['rebase', 'fixup'] if opts.get(flag, None)]
if opts.get('interactive') and badflags:
raise error.Abort(_('--interactive and --%s are mutually exclusive') %
badflags[0])
fixup = opts.get('fixup')
if fixup:
fixupamend(ui, repo)
return
old = repo['.']
if old.phase() == phases.public:
raise error.Abort(_('cannot amend public changesets'))
if len(repo[None].parents()) > 1:
raise error.Abort(_('cannot amend while merging'))
haschildren = len(old.children()) > 0
opts['message'] = cmdutil.logmessage(ui, opts)
# Avoid further processing of any logfile. If such a file existed, its
# contents have been copied into opts['message'] by logmessage
opts['logfile'] = ''
if not opts.get('noeditmessage') and not opts.get('message'):
opts['message'] = old.description()
tempnode = []
commitdate = old.date() if not opts.get('date') else opts.get('date')
def commitfunc(ui, repo, message, match, opts):
e = cmdutil.commiteditor
noderesult = repo.commit(message,
old.user(),
commitdate,
match,
editor=e,
extra={})
# the temporary commit is the very first commit
if not tempnode:
tempnode.append(noderesult)
return noderesult
active = bmactive(repo)
oldbookmarks = old.bookmarks()
if haschildren:
def fakestrip(orig, ui, repo, *args, **kwargs):
if tempnode:
if tempnode[0]:
# don't strip everything, just the temp node
# this is very hacky
orig(ui, repo, tempnode[0], backup='none')
tempnode.pop()
else:
orig(ui, repo, *args, **kwargs)
extensions.wrapfunction(repair, 'strip', fakestrip)
tr = None
wlock = None
lock = None
try:
wlock = repo.wlock()
lock = repo.lock()
if opts.get('interactive'):
# Strip the interactive flag to avoid infinite recursive loop
opts.pop('interactive')
cmdutil.dorecord(ui, repo, amend, None, False,
cmdutil.recordfilter, *pats, **opts)
return
else:
node = cmdutil.amend(ui, repo, commitfunc, old, {}, pats, opts)
if node == old.node():
ui.status(_("nothing changed\n"))
return 0
if haschildren and not rebase:
msg = _("warning: the changeset's children were left behind\n")
if _histediting(repo):
ui.warn(msg)
ui.status(_('(this is okay since a histedit is in progress)\n'))
else:
_usereducation(ui)
ui.warn(msg)
ui.status(_("(use 'hg amend --fixup' to rebase them)\n"))
newbookmarks = repo._bookmarks
# move old bookmarks to new node
for bm in oldbookmarks:
newbookmarks[bm] = node
userestack = ui.configbool('fbamend', 'userestack')
if not _histediting(repo) and not userestack:
preamendname = _preamendname(repo, node)
if haschildren:
newbookmarks[preamendname] = old.node()
elif not active:
# update bookmark if it isn't based on the active bookmark name
oldname = _preamendname(repo, old.node())
if oldname in repo._bookmarks:
newbookmarks[preamendname] = repo._bookmarks[oldname]
del newbookmarks[oldname]
tr = repo.transaction('fixupamend')
newbookmarks.recordchange(tr)
tr.close()
if rebase and haschildren:
fixupamend(ui, repo)
finally:
lockmod.release(wlock, lock, tr)
def fixupamend(ui, repo):
"""rebases any children found on the preamend changset and strips the
preamend changset
"""
wlock = None
lock = None
tr = None
try:
wlock = repo.wlock()
lock = repo.lock()
current = repo['.']
# Use obsolescence information to fix up the amend instead of relying
# on the preamend bookmark if the user enables this feature.
if ui.configbool('fbamend', 'userestack'):
with repo.transaction('fixupamend') as tr:
try:
_restackonce(ui, repo, current.rev())
except error.InterventionRequired:
tr.close()
raise
return
preamendname = _preamendname(repo, current.node())
if not preamendname in repo._bookmarks:
raise error.Abort(_('no bookmark %s') % preamendname,
hint=_('check if your bookmark is active'))
old = repo[preamendname]
if old == current:
hint = _('please examine smartlog and rebase your changsets '
'manually')
err = _('cannot automatically determine what to rebase '
'because bookmark "%s" points to the current changset') % \
preamendname
raise error.Abort(err, hint=hint)
oldbookmarks = old.bookmarks()
ui.status(_("rebasing the children of %s\n") % (preamendname))
active = bmactive(repo)
opts = {
'rev' : [str(c.rev()) for c in old.descendants()],
'dest' : current.rev()
}
if opts['rev'] and opts['rev'][0]:
rebasemod.rebase(ui, repo, **opts)
for bookmark in oldbookmarks:
repo._bookmarks.pop(bookmark)
tr = repo.transaction('fixupamend')
repo._bookmarks.recordchange(tr)
if obsolete.isenabled(repo, obsolete.createmarkersopt):
# clean up the original node if inhibit kept it alive
if not old.obsolete():
obsolete.createmarkers(repo, [(old,())])
tr.close()
else:
tr.close()
repair.strip(ui, repo, old.node(), topic='preamend-backup')
merge.update(repo, current.node(), False, True, False)
if active:
bmactivate(repo, active)
finally:
lockmod.release(wlock, lock, tr)
def nextrebase(orig, ui, repo, **opts):
# Disable `hg next --evolve`. The --rebase flag takes its place.
if opts['evolve']:
raise error.Abort(
_("the --evolve flag is not supported"),
hint=_("use 'hg next --rebase' instead")
)
# Just perform `hg next` if no --rebase option.
if not opts['rebase']:
return orig(ui, repo, **opts)
with nested(repo.wlock(), repo.lock()):
_nextrebase(orig, ui, repo, **opts)
def _nextrebase(orig, ui, repo, **opts):
"""Wrapper around the evolve extension's next command, adding the
--rebase option, which detects whether the current changeset has
any children on an obsolete precursor, and if so, rebases those
children onto the current version.
"""
# Abort if there is an unfinished operation or changes to the
# working copy, to be consistent with the behavior of `hg next`.
cmdutil.checkunfinished(repo)
cmdutil.bailifchanged(repo)
# Find all children on the current changeset's obsolete precursors.
precursors = list(repo.set('allprecursors(.)'))
children = []
for p in precursors:
children.extend(p.children())
# If there are no children on precursors, just do `hg next` normally.
if not children:
ui.warn(_("found no changesets to rebase, "
"doing normal 'hg next' instead\n"))
return orig(ui, repo, **opts)
current = repo['.']
child = children[0]
showopts = {'template': '[{shortest(node)}] {desc|firstline}\n'}
displayer = cmdutil.show_changeset(ui, repo, showopts)
# Catch the case where there are children on precursors, but
# there are also children on the current changeset.
if list(current.children()):
ui.warn(_("there are child changesets on one or more previous "
"versions of the current changeset, but the current "
"version also has children\n"))
ui.status(_("skipping rebasing the following child changesets:\n"))
for c in children:
displayer.show(c)
return orig(ui, repo, **opts)
# If there are several children on one or more precusors, it is
# ambiguous which changeset to rebase and update to.
if len(children) > 1:
ui.warn(_("there are multiple child changesets on previous versions "
"of the current changeset, namely:\n"))
for c in children:
displayer.show(c)
raise error.Abort(
_("ambiguous next changeset to rebase"),
hint=_("please rebase the desired one manually")
)
# If doing a dry run, just print out the corresponding commands.
if opts['dry_run']:
ui.write(('hg rebase -r %s -d %s -k\n' % (child.hex(), current.hex())))
# Since we don't know what the new hashes will be until we actually
# perform the rebase, the dry run output can't explicitly say
# `hg update %s`. This is different from the normal output
# of `hg next --dry-run`.
ui.write(('hg next\n'))
return
# When the transaction closes, inhibition markers will be added back to
# changesets that have non-obsolete descendants, so those won't be
# "stripped". As such, we're relying on the inhibition markers to take
# care of the hard work of identifying which changesets not to strip.
with repo.transaction('nextrebase') as tr:
# Rebase any children of the obsolete changesets.
try:
rebasemod.rebase(ui, repo, rev=[child.rev()], dest=current.rev(),
keep=True)
except error.InterventionRequired:
ui.status(_(
"please resolve any conflicts, run 'hg rebase --continue', "
"and then run 'hg next'\n"
))
tr.close()
raise
# There isn't a good way of getting the newly rebased child changeset
# from rebasemod.rebase(), so just assume that it's the current
# changeset's only child. (This should always be the case.)
rebasedchild = current.children()[0]
ancestors = repo.set('%d %% .', child.rev())
# Mark the old child changeset as obsolete, and remove the
# the inhibition markers from it and its ancestors. This
# effectively "strips" all of the obsoleted changesets in the
# stack below the child.
_deinhibit(repo, ancestors)
obsolete.createmarkers(
repo,
[(child, [rebasedchild])],
metadata={'operation': 'rebase'}
)
# Remove any preamend bookmarks on precursors, as these would
# create unnecessary inhibition markers.
_clearpreamend(repo, precursors)
# Run `hg next` to update to the newly rebased child.
return orig(ui, repo, **opts)
def rebaserestack(orig, ui, repo, **opts):
"""Wrapper around `hg rebase` adding the `--restack` option, which rebases
all "unstable" descendants of an obsolete changeset onto the latest
version of that changeset. This is similar to (and intended as a
replacement for) the `hg evolve --all` command.
"""
if not opts['restack']:
return orig(ui, repo, **opts)
if opts['rev']:
raise error.Abort(_("cannot use both --rev and --restack"))
if opts['dest']:
raise error.Abort(_("cannot use both --dest and --restack"))
if opts['source']:
raise error.Abort(_("cannot use both --source and --restack"))
if opts['base']:
raise error.Abort(_("cannot use both --base and --restack"))
if opts['abort']:
raise error.Abort(_("cannot use both --abort and --restack"))
if opts['continue']:
raise error.Abort(_("cannot use both --continue and --restack"))
restack(ui, repo, opts)
def restack(ui, repo, rebaseopts=None):
"""Repair a situation in which one or more changesets in a stack
have been obsoleted (thereby leaving their descendants in the stack
unstable) by finding any such changesets and rebasing their descendants
onto the latest version of each respective changeset.
"""
if rebaseopts is None:
rebaseopts = {}
with nested(repo.wlock(), repo.lock()):
cmdutil.checkunfinished(repo)
cmdutil.bailifchanged(repo)
# Identify a base changeset from which to begin stabilizing.
base = _findrestackbase(repo)
targets = _findrestacktargets(repo, base)
with repo.transaction('restack') as tr:
# Attempt to stabilize all changesets that are or will be (after
# rebasing) descendants of base.
for rev in targets:
try:
_restackonce(ui, repo, rev, rebaseopts)
except error.InterventionRequired:
tr.close()
raise
# If we're currently on one of the precursors of the base, update
# to the latest successor since the old changeset is no longer
# needed. Note that if we're on a descendant of the base or its
# precurosrs, the rebase command will ensure that we end up on a
# non-obsolete changeset, so it is only necessary to explicitly
# update if we're on a precursor of the base.
if not repo.revs('. - allprecursors(%d)', base):
commands.update(ui, repo, rev=base)
def _restackonce(ui, repo, rev, rebaseopts=None):
"""Rebase all descendants of precursors of rev onto rev, thereby
stabilzing any non-obsolete descendants of those precursors.
"""
# Get visible descendants of precusors of rev.
allprecursors = repo.revs('allprecursors(%d)', rev)
descendants = repo.revs('descendants(%ld) - %ld', allprecursors,
allprecursors)
# Nothing to do if there are no descendants.
if not descendants:
return
# Overwrite source and destination, leave all other options.
if rebaseopts is None:
rebaseopts = {}
rebaseopts['rev'] = descendants
rebaseopts['dest'] = rev
rebasemod.rebase(ui, repo, **rebaseopts)
# Remove any preamend bookmarks and any inhibition markers
# on precursors so that they will be correctly labelled as
# obsolete. The rebase command will obsolete the descendants,
# so we only need to do this for the precursors.
contexts = [repo[r] for r in allprecursors]
_clearpreamend(repo, contexts)
_deinhibit(repo, contexts)
def _findrestackbase(repo):
"""Search backwards through history to find a changeset in the current
stack that may have unstable descendants on its precursors, or
may itself need to be stabilized.
"""
# Move down current stack until we find a changeset with visible
# precursors or successors, indicating that we may need to stabilize
# some descendants of this changeset or its precursors.
stack = repo.revs('::. & draft()')
stack.reverse()
for rev in stack:
# Is this the latest version of this changeset? If not, we need
# to rebase any unstable descendants onto the latest version.
latest = _latest(repo, rev)
if rev != latest:
return latest
# If we're already on the latest version, check if there are any
# visible precusors. If so, we need to rebase their descendants.
if repo.revs('allprecursors(%d)', rev):
return rev
# If we don't encounter any changesets with precursors or successors
# on the way down, assume the user just wants to recusively fix
# the stack upwards from the current changeset.
return repo['.'].rev()
def _findrestacktargets(repo, base):
"""Starting from the given base revision, do a BFS forwards through
history, looking for changesets with unstable descendants on their
precursors. Returns a list of any such changesets, in a top-down
ordering that will allow all of the descendants of their precursors
to be correctly rebased.
"""
childrenof = _getchildrelationships(repo, base)
# Perform BFS starting from base.
queue = deque([base])
targets = []
processed = set()
while queue:
rev = queue.popleft()
# Merges may result in the same revision being added to the queue
# multiple times. Filter those cases out.
if rev in processed:
continue
processed.add(rev)
queue.extend(childrenof[rev])
# Look for visible precursors (which are probably visible because
# they have unstable descendants) and successors (for which the latest
# non-obsolete version should be visible).
precursors = repo.revs('allprecursors(%d)', rev)
successors = repo.revs('allsuccessors(%d)', rev)
# If this changeset has precursors but no successor, then
# if its precursors have children those children need to be
# rebased onto the changeset.
if precursors and not successors:
children = []
for p in precursors:
children.extend(childrenof[p])
if children:
queue.extend(children)
targets.append(rev)
# We need to perform the rebases in reverse-BFS order so that
# obsolescence information at lower levels is not modified by rebases
# at higher levels.
return reversed(targets)
def _getchildrelationships(repo, base):
"""Build a defaultdict of child relationships between all descendants of
base. This information will prevent us from having to repeatedly
perform children that reconstruct these relationships each time.
"""
cl = repo.changelog
children = defaultdict(list)
for rev in repo.revs('%d:: + allprecursors(%d)::', base, base):
for parent in cl.parentrevs(rev):
if parent != nullrev:
children[parent].append(rev)
return children
def _latest(repo, rev):
"""Find the "latest version" of the given revision -- either the
latest visible successor, or the revision itself if it has no
visible successors. Throws an exception if divergence is
detected.
"""
unfiltered = repo.unfiltered()
def leadstovisible(rev):
"""Return true if the given revision is visble, or if one
of the revisions in its chain of successors is visible.
"""
try:
return repo.revs('allsuccessors(%d) + %d', rev, rev)
except error.FilteredRepoLookupError:
return False
def getsuccessors(rev):
"""Return all successors of the given revision that leads
to a visible successor.
"""
return [
r for r in unfiltered.revs('successors(%d)', rev)
if leadstovisible(r)
]
# Right now this loop runs in O(n^2) due to the allsuccessors
# lookup inside getsuccessors(). This check is neccesary to deal
# with unamended changesets (which create situations where
# the latest successor is acutally obsolete, and we want a
# precursor instead. This logic could probably be made more
# sophisticated for better performance.
successors = getsuccessors(rev)
while successors:
if len(successors) > 1:
raise error.Abort(_("changeset %s has multiple newer versions, "
"cannot automatically determine latest verion")
% unfiltered[rev].hex())
rev = successors[0]
successors = getsuccessors(rev)
return rev
def _clearpreamend(repo, contexts):
"""Remove any preamend bookmarks on the given change contexts."""
for ctx in contexts:
for bookmark in repo.nodebookmarks(ctx.node()):
if bookmark.endswith('.preamend'):
repo._bookmarks.pop(bookmark, None)
def _deinhibit(repo, contexts):
"""Remove any inhibit markers on the given change contexts."""
if inhibitmod:
inhibitmod._deinhibitmarkers(repo, (ctx.node() for ctx in contexts))
def _preamendname(repo, node):
suffix = '.preamend'
name = bmactive(repo)
if not name:
name = hex(node)[:12]
return name + suffix
def _histediting(repo):
return repo.vfs.exists('histedit-state')
def _usereducation(ui):
"""
You can print out a message to the user here
"""
education = ui.config('fbamend', 'education')
if education:
ui.warn(education + "\n")
### bookmarks api compatibility layer ###
def bmactivate(repo, mark):
try:
return bookmarks.activate(repo, mark)
except AttributeError:
return bookmarks.setcurrent(repo, mark)
def bmactive(repo):
try:
return repo._activebookmark
except AttributeError:
return repo._bookmarkcurrent