This is an archive of the discontinued Mercurial Phabricator instance.

Differential D410

undo: unfinished command handling
ClosedPublic

Authored by felixmerk on Aug 15 2017, 7:46 PM.
Tags
None
Subscribers
quark

Details

Reviewers
quark
Group Reviewers
Restricted Project
Commits
rFBHGXa6e1cbdde822: undo: unfinished command handling
Summary

hg rebase, histedit, unshelve and other commands may stop in an unfinished state
because of merge conflicts or other reasons. The user then has the ability to
continue or abort. Undoing in this case is slightly tricky as for example
aborting a rebase will perform real strips and so undo will fail with an error.
This change still records these states, but flags them as unfinished and skips
over them when undoing and redoing. Hg undo --absolute does not ignore these
states in the really unlikely situation you want to go to one of them.

Diff Detail

Repository
rFBHGX Facebook Mercurial Extensions
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

felixmerk created this revision.Aug 15 2017, 7:46 PM
Herald added a reviewer: Restricted Project. · View Herald TranscriptAug 15 2017, 7:46 PM
quark requested changes to this revision.Aug 15 2017, 9:40 PM
quark added a subscriber: quark.
quark added inline comments.
hgext3rd/undo.py
81

I think InterventionRequired is not the only cause of "unfinished" state. We probably want to have a similar check like cmdutil.checkunfinished to mark things as "unfinished". That covers wider cases than just InterventionRequired.

90–91

Maybe add a new state to undolog, like:

safelog(repo, command, unfinished=unfinished)
179

Append:

'unfinished': (unfinished and '1' or '0')

here.

This revision now requires changes to proceed.Aug 15 2017, 9:40 PM
felixmerk added inline comments.Aug 16 2017, 4:43 PM
hgext3rd/undo.py
81

Sure, I can add a checkunfinished, but the exception is still thrown. I need to explicitly catch every exception that causes and unfinished state as otherwise I won't be able to checkunfinished. I guess I could catch all exceptions, but I'm not sure that this would be safe?

felixmerk edited edge metadata.Aug 16 2017, 8:19 PM
felixmerk updated this revision to Diff 1021.
quark accepted this revision.Aug 18 2017, 11:02 AM

Looks good to me. Sorry for missing this one.

This revision is now accepted and ready to land.Aug 18 2017, 11:02 AM
Closed by commit rFBHGXa6e1cbdde822: undo: unfinished command handling (authored by felixmerk). · Explain WhyAug 21 2017, 8:17 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mhgext3rd/undo.py (63 lines)
Mtests/test-undo.t (172 lines)

Diff 1135

hgext3rd/undo.py

# prevent nested calls # prevent nested calls
if '_undologactive' not in os.environ: if '_undologactive' not in os.environ:
os.environ['_undologactive'] = "active" os.environ['_undologactive'] = "active"
rootlog = True rootlog = True
else: else:
rootlog = False rootlog = False
try:
result = orig(lui, repo, cmd, fullargs, *args) result = orig(lui, repo, cmd, fullargs, *args)
finally:
if repo is not None:
quarkUnsubmitted
Not Done

I think InterventionRequired is not the only cause of "unfinished" state. We probably want to have a similar check like cmdutil.checkunfinished to mark things as "unfinished". That covers wider cases than just InterventionRequired.

quark: I think `InterventionRequired` is not the only cause of "unfinished" state. We probably want to…
felixmerkAuthorUnsubmitted
Not Done

Sure, I can add a checkunfinished, but the exception is still thrown. I need to explicitly catch every exception that causes and unfinished state as otherwise I won't be able to checkunfinished. I guess I could catch all exceptions, but I'm not sure that this would be safe?

felixmerk: Sure, I can add a checkunfinished, but the exception is still thrown. I need to explicitly…
# mercurial is bad with caches # mercurial is bad with caches
# eg update to hidden commit will leave false cache # eg update to hidden commit will leave false cache
if repo:
repo.invalidatevolatilesets() repo.invalidatevolatilesets()
# record changes to repo # record changes to repo
if rootlog: if rootlog:
safelog(repo, command) safelog(repo, command)
del os.environ['_undologactive'] del os.environ['_undologactive']
return result return result
quarkUnsubmitted
Not Done

Maybe add a new state to undolog, like:

safelog(repo, command, unfinished=unfinished)
quark: Maybe add a new state to undolog, like: ``` safelog(repo, command, unfinished=unfinished) ```
# Write: Log control # Write: Log control
def safelog(repo, command): def safelog(repo, command):
'''boilerplate for log command '''boilerplate for log command
input: input:
repo: mercurial.localrepo repo: mercurial.localrepo
existingnodes = {} existingnodes = {}
if all(newnodes.get(x) == existingnodes.get(x) for x in newnodes.keys()): if all(newnodes.get(x) == existingnodes.get(x) for x in newnodes.keys()):
# no changes to record # no changes to record
return False return False
else: else:
newnodes.update({ newnodes.update({
'date': _logdate(repo, tr), 'date': _logdate(repo, tr),
'command': _logcommand(repo, tr, command), 'command': _logcommand(repo, tr, command),
'unfinished': unfinished(repo),
}) })
quarkUnsubmitted
Not Done

Append:

'unfinished': (unfinished and '1' or '0')

here.

quark: Append: 'unfinished': (unfinished and '1' or '0') here.
_logindex(repo, tr, newnodes) _logindex(repo, tr, newnodes)
# changes have been recorded # changes have been recorded
return True return True
def unfinished(repo, commit=False):
'''like cmdutil.checkunfinished without raising an Abort'''
for f, clearable, allowcommit, msg, hint in cmdutil.unfinishedstates:
if commit and allowcommit:
continue
if repo.vfs.exists(f):
return True
return False
# Write: Logs # Write: Logs
def writelog(repo, tr, name, revstring): def writelog(repo, tr, name, revstring):
if tr is None: if tr is None:
raise error.ProgrammingError raise error.ProgrammingError
rlog = _getrevlog(repo, name) rlog = _getrevlog(repo, name)
node = rlog.addrevision(revstring, tr, 1, nullid, nullid) node = rlog.addrevision(revstring, tr, 1, nullid, nullid)
return hex(node) return hex(node)
if "" == rawcontent: if "" == rawcontent:
content = "unkown command(s) run, gap in log" content = "unkown command(s) run, gap in log"
else: else:
content = rawcontent.split("\0", 1)[1] content = rawcontent.split("\0", 1)[1]
else: else:
content = rawcontent content = rawcontent
fm.startitem() fm.startitem()
fm.write('content', '%s', header + content) fm.write('content', '%s', header + content)
fm.write('content', '%s', "unfinished:\t" + nodedict['unfinished'])
fm.end() fm.end()
# Revset logic # Revset logic
def _getolddrafts(repo, reverseindex): def _getolddrafts(repo, reverseindex):
# convert reverseindex to node # convert reverseindex to node
# this makes cacheing guaranteed correct # this makes cacheing guaranteed correct
# bc immutable history # bc immutable history
if interactive: if interactive:
preview = True preview = True
repo = repo.unfiltered() repo = repo.unfiltered()
if branch and reverseindex != 1 and reverseindex != -1: if branch and reverseindex != 1 and reverseindex != -1:
raise error.Abort(_("--branch with --index not supported")) raise error.Abort(_("--branch with --index not supported"))
if relativeundo: if relativeundo:
try:
reverseindex = _computerelative(repo, reverseindex, reverseindex = _computerelative(repo, reverseindex,
absolute = not relativeundo, absolute = not relativeundo,
branch = branch) branch = branch)
except IndexError:
raise error.Abort(_("index out of bounds"))
if branch and preview: if branch and preview:
raise error.Abort(_("--branch with --preview not supported")) raise error.Abort(_("--branch with --preview not supported"))
if interactive: if interactive:
try: try:
interactiveui = extensions.find('interactiveui') interactiveui = extensions.find('interactiveui')
except KeyError: except KeyError:
raise error.Abort(_('undo --interactive requires interactiveui to ' raise error.Abort(_('undo --interactive requires interactiveui to '
# if we run into something that isn't undo or redo, we Abort (including # if we run into something that isn't undo or redo, we Abort (including
# gaps in the log) # gaps in the log)
# we extract the --index arguments out of undoes to make sure we update # we extract the --index arguments out of undoes to make sure we update
# the undoredo index correctly # the undoredo index correctly
nodedict = _readindex(repo, reverseindex) nodedict = _readindex(repo, reverseindex)
commandstr = _readnode(repo, 'command.i', nodedict['command']) commandstr = _readnode(repo, 'command.i', nodedict['command'])
commandlist = commandstr.split("\0") commandlist = commandstr.split("\0")
if commandlist[0] == "undo": if 'True' == nodedict['unfinished']:
# don't want to redo to an interupted state
reverseindex += 1
elif commandlist[0] == "undo":
undoopts = {} undoopts = {}
fancyopts.fancyopts(commandlist, fancyopts.fancyopts(commandlist,
cmdtable['undo'][1] + commands.globalopts, cmdtable['undo'][1] + commands.globalopts,
undoopts, gnu=True) undoopts, gnu=True)
if redocount == 0: if redocount == 0:
# want to go to state before the undo (not after) # want to go to state before the undo (not after)
toshift = undoopts['step'] toshift = undoopts['step']
shiftedindex -= toshift shiftedindex -= toshift
smarthide(repo, addedrevs, localremoves, local=True) smarthide(repo, addedrevs, localremoves, local=True)
revealcommits(repo, localremoves) revealcommits(repo, localremoves)
def _computerelative(repo, reverseindex, absolute=False, branch=""): def _computerelative(repo, reverseindex, absolute=False, branch=""):
# allows for relative undos using # allows for relative undos using
# redonode storage # redonode storage
# allows for branch undos using # allows for branch undos using
# findnextdelta logic # findnextdelta logic
if reverseindex != 0:
sign = reverseindex / abs(reverseindex)
else:
sign = None
if not absolute: if not absolute:
try: # attempt to get relative shift try: # attempt to get relative shift
nodebranch = repo.vfs.read("undolog/redonode").split("\0") nodebranch = repo.vfs.read("undolog/redonode").split("\0")
hexnode = nodebranch[0] hexnode = nodebranch[0]
try: try:
oldbranch = nodebranch[1] oldbranch = nodebranch[1]
except IndexError: except IndexError:
oldbranch = "" oldbranch = ""
# from shifted index, find reverse index # of states that change # from shifted index, find reverse index # of states that change
# branch # branch
# remember that reverseindex can be negative # remember that reverseindex can be negative
sign = reverseindex / abs(reverseindex) sign = reverseindex / abs(reverseindex)
for count in range(abs(reverseindex)): for count in range(abs(reverseindex)):
shiftedindex = _findnextdelta(repo, shiftedindex, branch, shiftedindex = _findnextdelta(repo, shiftedindex, branch,
direction=sign) direction=sign)
reverseindex = shiftedindex reverseindex = shiftedindex
# skip interupted commands
if sign:
done = False
rlog = _getrevlog(repo, 'index.i')
while not done:
indexdict = _readindex(repo, reverseindex, rlog)
if 'True' == indexdict['unfinished']:
reverseindex += sign
else:
done = True
return reverseindex return reverseindex
def _findnextdelta(repo, reverseindex, branch, direction): def _findnextdelta(repo, reverseindex, branch, direction):
# finds closest repos state making changes to branch in direction # finds closest repos state making changes to branch in direction
# input: # input:
# repo: mercurial.localrepo # repo: mercurial.localrepo
# reverseindex: positive int for index.i # reverseindex: positive int for index.i
# branch: string changectx (commit hash) # branch: string changectx (commit hash)
while not done: while not done:
# move index # move index
incrementalindex += direction incrementalindex += direction
# check this index # check this index
try: try:
nodedict = _readindex(repo, incrementalindex) nodedict = _readindex(repo, incrementalindex)
except IndexError: except IndexError:
raise error.Abort(_("index out of bounds")) raise error.Abort(_("index out of bounds"))
# skip interupted commands
if 'True' == nodedict['unfinished']:
break
# check wkp, commits, bookmarks # check wkp, commits, bookmarks
workingcopyparent = _readnode(repo, "workingparent.i", workingcopyparent = _readnode(repo, "workingparent.i",
nodedict["workingparent"]) nodedict["workingparent"])
bookstring = _readnode(repo, "bookmarks.i", nodedict["bookmarks"]) bookstring = _readnode(repo, "bookmarks.i", nodedict["bookmarks"])
# local changes in respect to visible changectxs # local changes in respect to visible changectxs
# disjunctive union of present and old = changes # disjunctive union of present and old = changes
# intersection of changes and local = localchanges # intersection of changes and local = localchanges
localctxchanges = revsetlang.formatspec( localctxchanges = revsetlang.formatspec(

tests/test-undo.t

df4fd610a3d6ca792281e7576587fa18f940d37a (no-eol) df4fd610a3d6ca792281e7576587fa18f940d37a (no-eol)
$ hg debugdata .hg/undolog/draftheads.i 2 $ hg debugdata .hg/undolog/draftheads.i 2
b68836a6e2cac33ba33a20249b85a486eec78186 (no-eol) b68836a6e2cac33ba33a20249b85a486eec78186 (no-eol)
$ hg debugdata .hg/undolog/index.i 1 $ hg debugdata .hg/undolog/index.i 1
bookmarks 8153d44860d076e9c328951c8f36cf8daebe695a bookmarks 8153d44860d076e9c328951c8f36cf8daebe695a
command bae41a9d0ae9614fc3aa843a0f5cbdf47bc98c43 command bae41a9d0ae9614fc3aa843a0f5cbdf47bc98c43
date * (glob) date * (glob)
draftheads b80de5d138758541c5f05265ad144ab9fa86d1db draftheads b80de5d138758541c5f05265ad144ab9fa86d1db
unfinished False
workingparent fcb754f6a51eaf982f66d0637b39f3d2e6b520d5 (no-eol) workingparent fcb754f6a51eaf982f66d0637b39f3d2e6b520d5 (no-eol)
$ touch a3 && hg add a3 $ touch a3 && hg add a3
$ hg commit --amend $ hg commit --amend
$ hg debugdata .hg/undolog/command.i 11 $ hg debugdata .hg/undolog/command.i 11
commit\x00commit\x00--amend (no-eol) (esc) commit\x00commit\x00--amend (no-eol) (esc)
Test debugundohistory Test debugundohistory
$ hg debugundohistory -l $ hg debugundohistory -l
master 0a3dd3e15e65b90836f492112d816f3ee073d897 master 0a3dd3e15e65b90836f492112d816f3ee073d897
date: date:
* (glob) * (glob)
draftheads: draftheads:
ADDED: ADDED:
0a3dd3e15e65b90836f492112d816f3ee073d897 0a3dd3e15e65b90836f492112d816f3ee073d897
REMOVED: REMOVED:
workingparent: unfinished: False
0a3dd3e15e65b90836f492112d816f3ee073d897
Test gap in data (extension dis and enabled) Test gap in data (extension dis and enabled)
$ hg debugundohistory -l $ hg debugundohistory -l
0: commit -m words 0: commit -m words
1: update master 1: update master
2: commit --amend 2: commit --amend
3: ci -md 3: ci -md
4: book feature2 4: book feature2
master 1dafc0b436123cab96f82a8e9e8d1d42c0301aaa master 1dafc0b436123cab96f82a8e9e8d1d42c0301aaa
date: date:
* (glob) * (glob)
draftheads: draftheads:
ADDED: ADDED:
1dafc0b436123cab96f82a8e9e8d1d42c0301aaa 1dafc0b436123cab96f82a8e9e8d1d42c0301aaa
REMOVED: REMOVED:
0a3dd3e15e65b90836f492112d816f3ee073d897 0a3dd3e15e65b90836f492112d816f3ee073d897
workingparent: unfinished: False
1dafc0b436123cab96f82a8e9e8d1d42c0301aaa
Index out of bound error Index out of bound error
$ hg debugundohistory -n 50 $ hg debugundohistory -n 50
abort: index out of bounds abort: index out of bounds
[255] [255]
Revset tests Revset tests
$ hg log -G -r 'draft()' --hidden > /dev/null $ hg log -G -r 'draft()' --hidden > /dev/null
$ hg debugundohistory -n 0 $ hg debugundohistory -n 0
command: command:
ci -ma5 ci -ma5
bookmarks: bookmarks:
feature1 49cdb4091aca3c09f402ff001cd20cf086873683 feature1 49cdb4091aca3c09f402ff001cd20cf086873683
feature2 296fda51a303650465d07a1cd054075cbe6d3cbd feature2 296fda51a303650465d07a1cd054075cbe6d3cbd
master aa430c8afedf9b2ec3f0655d39eef6b6b0a2ddb6 master aa430c8afedf9b2ec3f0655d39eef6b6b0a2ddb6
date: date:
* (glob) * (glob)
draftheads: draftheads:
ADDED: ADDED:
aa430c8afedf9b2ec3f0655d39eef6b6b0a2ddb6 aa430c8afedf9b2ec3f0655d39eef6b6b0a2ddb6
REMOVED: REMOVED:
1dafc0b436123cab96f82a8e9e8d1d42c0301aaa 1dafc0b436123cab96f82a8e9e8d1d42c0301aaa
workingparent: unfinished: False
aa430c8afedf9b2ec3f0655d39eef6b6b0a2ddb6
Test 'olddraft([NUM])' revset Test 'olddraft([NUM])' revset
$ hg log -G -r 'olddraft(0) - olddraft(1)' --hidden -T compact $ hg log -G -r 'olddraft(0) - olddraft(1)' --hidden -T compact
@ 10[tip][master] aa430c8afedf 1970-01-01 00:00 +0000 test @ 10[tip][master] aa430c8afedf 1970-01-01 00:00 +0000 test
| a5 | a5
~ ~
$ hg log -G -r 'olddraft(1) and draft()' -T compact $ hg log -G -r 'olddraft(1) and draft()' -T compact
o 9 1dafc0b43612 1970-01-01 00:00 +0000 test o 9 1dafc0b43612 1970-01-01 00:00 +0000 test
c1 c1
@ 24:-1 90af9088326b 1970-01-01 00:00 +0000 test @ 24:-1 90af9088326b 1970-01-01 00:00 +0000 test
b1 b1
o 23 a0b72b3048d6 1970-01-01 00:00 +0000 test o 23 a0b72b3048d6 1970-01-01 00:00 +0000 test
| prev1 | prev1
~ ~
Interupted commands
Commands like hg rebase, unshelve and histedit may interupt in order for the
user to solve merge conflicts etc. Since for example hg rebase --abort may
permanently delete a commit, we do not want to undo to this state.
$ touch afile
$ echo "afile" > afile
$ hg add afile && hg ci -m afile
$ hg up 0963b9e31e70
3 files updated, 0 files merged, 2 files removed, 0 files unresolved
$ touch afile
$ echo "bfile" > afile
$ hg add afile && hg ci -m bfile
$ hg log -G -T compact -l6
@ 31[tip]:29 00617a57f780 1970-01-01 00:00 +0000 test
| bfile
|
| o 30:24 28dfc398cab7 1970-01-01 00:00 +0000 test
| | afile
| |
o | 29 0963b9e31e70 1970-01-01 00:00 +0000 test
| | c3
| |
o | 28 4e0ac6fa4ca0 1970-01-01 00:00 +0000 test
| | c2
| |
o | 27:-1 c54b1b73bb58 1970-01-01 00:00 +0000 test
/ c1
|
o 24:-1 90af9088326b 1970-01-01 00:00 +0000 test
b1
$ cat >> $HGRCPATH <<EOF
> [extensions]
> rebase =
> EOF
$ hg rebase -r 00617 -d 28dfc
rebasing 31:00617a57f780 "bfile" (tip)
merging afile
warning: conflicts while merging afile! (edit, then use 'hg resolve --mark')
unresolved conflicts (see hg resolve, then hg rebase --continue)
[1]
$ hg log -G -T compact -l6
@ 31[tip]:29 00617a57f780 1970-01-01 00:00 +0000 test
| bfile
|
| @ 30:24 28dfc398cab7 1970-01-01 00:00 +0000 test
| | afile
| |
o | 29 0963b9e31e70 1970-01-01 00:00 +0000 test
| | c3
| |
o | 28 4e0ac6fa4ca0 1970-01-01 00:00 +0000 test
| | c2
| |
o | 27:-1 c54b1b73bb58 1970-01-01 00:00 +0000 test
/ c1
|
o 24:-1 90af9088326b 1970-01-01 00:00 +0000 test
b1
$ hg resolve -m afile
(no more unresolved files)
continue: hg rebase --continue
$ hg rebase --continue
rebasing 31:00617a57f780 "bfile" (tip)
$ hg log -G -T compact -l6
@ 32[tip]:30 e642892c5cb0 1970-01-01 00:00 +0000 test
| bfile
|
o 30:24 28dfc398cab7 1970-01-01 00:00 +0000 test
| afile
|
| o 29 0963b9e31e70 1970-01-01 00:00 +0000 test
| | c3
| |
| o 28 4e0ac6fa4ca0 1970-01-01 00:00 +0000 test
| | c2
| |
| o 27:-1 c54b1b73bb58 1970-01-01 00:00 +0000 test
| c1
|
o 24:-1 90af9088326b 1970-01-01 00:00 +0000 test
b1
$ hg undo
4 files updated, 0 files merged, 1 files removed, 0 files unresolved
$ hg log -G -T compact -l6
@ 31[tip]:29 00617a57f780 1970-01-01 00:00 +0000 test
| bfile
|
| o 30:24 28dfc398cab7 1970-01-01 00:00 +0000 test
| | afile
| |
o | 29 0963b9e31e70 1970-01-01 00:00 +0000 test
| | c3
| |
o | 28 4e0ac6fa4ca0 1970-01-01 00:00 +0000 test
| | c2
| |
o | 27:-1 c54b1b73bb58 1970-01-01 00:00 +0000 test
/ c1
|
o 24:-1 90af9088326b 1970-01-01 00:00 +0000 test
b1
$ hg redo
2 files updated, 0 files merged, 3 files removed, 0 files unresolved
$ hg log -G -T compact -l6
@ 32[tip]:30 e642892c5cb0 1970-01-01 00:00 +0000 test
| bfile
|
o 30:24 28dfc398cab7 1970-01-01 00:00 +0000 test
| afile
|
| o 29 0963b9e31e70 1970-01-01 00:00 +0000 test
| | c3
| |
| o 28 4e0ac6fa4ca0 1970-01-01 00:00 +0000 test
| | c2
| |
| o 27:-1 c54b1b73bb58 1970-01-01 00:00 +0000 test
| c1
|
o 24:-1 90af9088326b 1970-01-01 00:00 +0000 test
b1
$ hg undo
4 files updated, 0 files merged, 1 files removed, 0 files unresolved
$ hg rebase -r 00617 -d 28dfc
rebasing 31:00617a57f780 "bfile" (tip)
merging afile
warning: conflicts while merging afile! (edit, then use 'hg resolve --mark')
unresolved conflicts (see hg resolve, then hg rebase --continue)
[1]
$ hg rebase --abort
rebase aborted
$ hg undo
0 files updated, 0 files merged, 0 files removed, 0 files unresolved
$ hg log -G -T compact -l6
@ 31[tip]:29 00617a57f780 1970-01-01 00:00 +0000 test
| bfile
|
| o 30:24 28dfc398cab7 1970-01-01 00:00 +0000 test
| | afile
| |
o | 29 0963b9e31e70 1970-01-01 00:00 +0000 test
| | c3
| |
o | 28 4e0ac6fa4ca0 1970-01-01 00:00 +0000 test
| | c2
| |
o | 27:-1 c54b1b73bb58 1970-01-01 00:00 +0000 test
/ c1
|
o 24:-1 90af9088326b 1970-01-01 00:00 +0000 test
b1
$ cat >> $HGRCPATH <<EOF
> [extensions]
> rebase =!
> EOF