This is an archive of the discontinued Mercurial Phabricator instance.

Differential D6478

shelve: first prototype of storing unresolved changes
AbandonedPublic

Authored by navaneeth.suresh on Jun 5 2019, 2:36 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Summary

Before storing unresolved mergestate information in changeset level, I tried
to make the user store the partially resolved merge to restore for later
after fixing an urgent bug using the usual mergestate information in
$HGRCPATH/merge/ only.

This patch adds an --unresolved flag to shelve. Until now, a shelve
during a merge was aborted. This patch makes shelve to handle merge with
unresolved files. The usual mergestate information in $HGRCPATH/merge/ is
moved to $HGRCPATH/merge-unresolved/<basename>/ after shelving
and the working directory is updated to p1(). In the next patch, I'll make
unshelve to restore this information.

Unresolved shelve changesets are stored with the extra mapping
{'unresolved-merge': True}. Also, hg shelve --patch and
hg shelve --list will show unresolved files separately as:

$ hg shelve --list
default (unresolved)         (1s ago)    changes to: C

shelve will abort when:

  1. No merge is active on calling with --unresolved.
  2. No unresolved files found in active merge on calling with --unresolved.
  3. Merge is active on calling without --unresolved.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

pulkit added a subscriber: pulkit.Jun 6 2019, 1:02 PM

Over past few days, @navaneeth.suresh was working on building the initial prototype on bitbucket and I was reviewing his initial work there. Now we have a nice initial prototype ready, and we decided to move things to core.

This is a prototype, which helps us (especially Navaneeth) understand more about the things required to store etc. Right now, it just moves files from merge/ to merge-unresolved/<shelve-name>/ and storing an extra in the commit to denote that it contains an unresolved merge.

Reviews and ideas on how to move forward are greatly appreciated.

pulkit added inline comments.Jun 10 2019, 1:37 PM
hgext/shelve.py
511

vfs.exists can be used

511

also, this storing a mergestate code should go in a separate function.

512

vfs.makedir or vfs.mkdir can be used

513

vfs.rename should be used.

616

can we look into changeset extras here to decide whether this is an unresolved shelve or not here?

It will be nice to remove any details of our storage layer and only keep them to functions which stores and restores merge states.

pulkit added inline comments.Jun 10 2019, 1:41 PM
hgext/shelve.py
616

if looking into changeset extras can be expensive right now, let's have a function which tells whether a shelve is a unresolved shelve or not and move this code there.

navaneeth.suresh marked 4 inline comments as done.Jun 10 2019, 3:41 PM
navaneeth.suresh updated this revision to Diff 15432.
navaneeth.suresh added inline comments.Jun 10 2019, 3:50 PM
hgext/shelve.py
616

i don't think we can get shelvectx here. i tried the following code but, that failed to work(got the error: node not found). the shelve changesets can't be used during other than unshelve i guess (reference from _unshelverestorecommit()).

snode = shelvedfile(repo, sname, 'shelve').readinfo()['node']
shelvectx = repo[snode]

also, i can't find any global variable declarations to make the extra parsing one time only. one workaround should be adding a unresolved-merge: True to the shelvedfile. but, it uses scmutil.simplekeyvaluefile() to write only a key-value pair which is its node id.

pulkit added inline comments.Jun 10 2019, 6:45 PM
hgext/shelve.py
435

the function needs documentation on what this does and why it does so.

616

okay, then let's move this one liner to a separate function. Something like isunresolvedshelve(..) which does the repo.vfs.exists() thing.

1107

nit: will be nice to keep )] + cmdutil.walkopts, to a new line. as it was before.

navaneeth.suresh marked 6 inline comments as done.Jun 11 2019, 8:08 AM
navaneeth.suresh updated this revision to Diff 15436.
pulkit added inline comments.Jun 11 2019, 2:02 PM
hgext/shelve.py
618

let's do namewidth += len('unresolved)'

navaneeth.suresh added inline comments.Jun 11 2019, 2:29 PM
hgext/shelve.py
618

ideally, that should be len(' (unresolved)'), right? i haven't seen such use cases in the codebase though.

navaneeth.suresh marked an inline comment as done.Jun 11 2019, 3:31 PM
navaneeth.suresh added a comment.Jun 11 2019, 3:49 PM

Adding changes to D6479 and abandoning.

Revision Contents
Changeset List

PathPackages
Mhgext/shelve.py (43 lines)
AMtests/test-shelve-unresolved.t (158 lines)
Mtests/test-shelve.t (1 line)

Diff 15450

hgext/shelve.py

shelvedfile(repo, name, 'hg').writebundle(bases, node) shelvedfile(repo, name, 'hg').writebundle(bases, node)
# Create a matcher so that prefetch doesn't attempt to fetch the entire # Create a matcher so that prefetch doesn't attempt to fetch the entire
# repository pointlessly. # repository pointlessly.
match = scmutil.matchfiles(repo, repo[node].files()) match = scmutil.matchfiles(repo, repo[node].files())
with shelvedfile(repo, name, patchextension).opener('wb') as fp: with shelvedfile(repo, name, patchextension).opener('wb') as fp:
cmdutil.exportfile(repo, [node], fp, opts=mdiff.diffopts(git=True), cmdutil.exportfile(repo, [node], fp, opts=mdiff.diffopts(git=True),
match=match) match=match)
def _storeunresolvedmerge(repo, name):
pulkitUnsubmitted
Done

the function needs documentation on what this does and why it does so.

pulkit: the function needs documentation on what this does and why it does so.
"""Move the usual mergestate information from `.hg/merge` to
`.hg/merge-unresolved/<name>`.
This will clear the mergestate and also stores the mergestate
information for later restoration.
"""
if not repo.vfs.exists('merge-unresolved'):
repo.vfs.mkdir('merge-unresolved')
repo.vfs.rename('merge', 'merge-unresolved/%s' % name)
def _includeunknownfiles(repo, pats, opts, extra): def _includeunknownfiles(repo, pats, opts, extra):
s = repo.status(match=scmutil.match(repo[None], pats, opts), s = repo.status(match=scmutil.match(repo[None], pats, opts),
unknown=True) unknown=True)
if s.unknown: if s.unknown:
extra['shelve_unknown'] = '\0'.join(s.unknown) extra['shelve_unknown'] = '\0'.join(s.unknown)
repo[None].add(s.unknown) repo[None].add(s.unknown)
def _isunresolvedshelve(repo, sname):
"""Checks whether the given shelve is unresolved or not"""
return repo.vfs.exists('merge-unresolved/%s' % sname)
def _finishshelve(repo, tr): def _finishshelve(repo, tr):
if phases.supportinternal(repo): if phases.supportinternal(repo):
tr.close() tr.close()
else: else:
_aborttransaction(repo, tr) _aborttransaction(repo, tr)
def createcmd(ui, repo, pats, opts): def createcmd(ui, repo, pats, opts):
"""subcommand that creates a new shelve""" """subcommand that creates a new shelve"""
with repo.wlock(): with repo.wlock():
cmdutil.checkunfinished(repo) cmdutil.checkunfinished(repo)
return _docreatecmd(ui, repo, pats, opts) return _docreatecmd(ui, repo, pats, opts)
def _docreatecmd(ui, repo, pats, opts): def _docreatecmd(ui, repo, pats, opts):
wctx = repo[None] wctx = repo[None]
parents = wctx.parents() parents = wctx.parents()
if len(parents) > 1: unresolved = opts.get('unresolved')
raise error.Abort(_('cannot shelve while merging'))
parent = parents[0] parent = parents[0]
origbranch = wctx.branch() origbranch = wctx.branch()
ms = merge.mergestate.read(repo)
if unresolved:
if not ms.active():
raise error.Abort(_('no active mergestate found'))
elif not list(ms.unresolved()):
raise error.Abort(_('no unresolved '
'files found in the mergestate'))
elif ms.active():
raise error.Abort(_('mergestate found\n'
'try with --unresolved to shelve conflicts'))
if parent.node() != nodemod.nullid: if parent.node() != nodemod.nullid:
desc = "changes to: %s" % parent.description().split('\n', 1)[0] desc = "changes to: %s" % parent.description().split('\n', 1)[0]
else: else:
desc = '(changes in empty repository)' desc = '(changes in empty repository)'
if not opts.get('message'): if not opts.get('message'):
opts['message'] = desc opts['message'] = desc
lock = tr = activebookmark = None lock = tr = activebookmark = None
try: try:
lock = repo.lock() lock = repo.lock()
# use an uncommitted transaction to generate the bundle to avoid # use an uncommitted transaction to generate the bundle to avoid
# pull races. ensure we don't print the abort message to stderr. # pull races. ensure we don't print the abort message to stderr.
tr = repo.transaction('shelve', report=lambda x: None) tr = repo.transaction('shelve', report=lambda x: None)
interactive = opts.get('interactive', False) interactive = opts.get('interactive', False)
includeunknown = (opts.get('unknown', False) and includeunknown = (opts.get('unknown', False) and
not opts.get('addremove', False)) not opts.get('addremove', False))
name = getshelvename(repo, parent, opts) name = getshelvename(repo, parent, opts)
activebookmark = _backupactivebookmark(repo) activebookmark = _backupactivebookmark(repo)
extra = {'internal': 'shelve'} extra = {'internal': 'shelve'}
if unresolved:
extra['unresolved-merge'] = True
_storeunresolvedmerge(repo, name)
pulkitUnsubmitted
Done

vfs.exists can be used

pulkit: `vfs.exists` can be used
pulkitUnsubmitted
Done

also, this storing a mergestate code should go in a separate function.

pulkit: also, this storing a mergestate code should go in a separate function.
if includeunknown: if includeunknown:
pulkitUnsubmitted
Done

vfs.makedir or vfs.mkdir can be used

pulkit: `vfs.makedir` or `vfs.mkdir` can be used
_includeunknownfiles(repo, pats, opts, extra) _includeunknownfiles(repo, pats, opts, extra)
pulkitUnsubmitted
Done

vfs.rename should be used.

pulkit: `vfs.rename` should be used.
if _iswctxonnewbranch(repo) and not _isbareshelve(pats, opts): if _iswctxonnewbranch(repo) and not _isbareshelve(pats, opts):
# In non-bare shelve we don't store newly created branch # In non-bare shelve we don't store newly created branch
# at bundled commit # at bundled commit
repo.dirstate.setbranch(repo['.'].branch()) repo.dirstate.setbranch(repo['.'].branch())
commitfunc = getcommitfunc(extra, interactive, editor=True) commitfunc = getcommitfunc(extra, interactive, editor=True)
if not interactive: if not interactive:
st = shelvedfile(repo, name).stat() st = shelvedfile(repo, name).stat()
info.append((st[stat.ST_MTIME], shelvedfile(repo, pfx).filename())) info.append((st[stat.ST_MTIME], shelvedfile(repo, pfx).filename()))
return sorted(info, reverse=True) return sorted(info, reverse=True)
def listcmd(ui, repo, pats, opts): def listcmd(ui, repo, pats, opts):
"""subcommand that displays the list of shelves""" """subcommand that displays the list of shelves"""
pats = set(pats) pats = set(pats)
width = 80 width = 80
namewidth = 16
if not ui.plain(): if not ui.plain():
width = ui.termwidth() width = ui.termwidth()
namelabel = 'shelve.newest' namelabel = 'shelve.newest'
ui.pager('shelve') ui.pager('shelve')
for mtime, name in listshelves(repo): for mtime, name in listshelves(repo):
sname = util.split(name)[1] sname = util.split(name)[1]
if pats and sname not in pats: if pats and sname not in pats:
continue continue
if _isunresolvedshelve(repo, sname):
pulkitUnsubmitted
Done

can we look into changeset extras here to decide whether this is an unresolved shelve or not here?

It will be nice to remove any details of our storage layer and only keep them to functions which stores and restores merge states.

pulkit: can we look into changeset extras here to decide whether this is an unresolved shelve or not…
pulkitUnsubmitted
Done

if looking into changeset extras can be expensive right now, let's have a function which tells whether a shelve is a unresolved shelve or not and move this code there.

pulkit: if looking into changeset extras can be expensive right now, let's have a function which tells…
navaneeth.sureshAuthorUnsubmitted
Done

i don't think we can get shelvectx here. i tried the following code but, that failed to work(got the error: node not found). the shelve changesets can't be used during other than unshelve i guess (reference from _unshelverestorecommit()).

snode = shelvedfile(repo, sname, 'shelve').readinfo()['node']
shelvectx = repo[snode]

also, i can't find any global variable declarations to make the extra parsing one time only. one workaround should be adding a unresolved-merge: True to the shelvedfile. but, it uses scmutil.simplekeyvaluefile() to write only a key-value pair which is its node id.

navaneeth.suresh: i don't think we can get `shelvectx` here. i tried the following code but, that failed to work…
pulkitUnsubmitted
Done

okay, then let's move this one liner to a separate function. Something like isunresolvedshelve(..) which does the repo.vfs.exists() thing.

pulkit: okay, then let's move this one liner to a separate function. Something like `isunresolvedshelve…
sname += ' (unresolved)'
namewidth += len(' (unresolved)')
pulkitUnsubmitted
Done

let's do namewidth += len('unresolved)'

pulkit: let's do `namewidth += len('unresolved)'`
navaneeth.sureshAuthorUnsubmitted
Done

ideally, that should be len(' (unresolved)'), right? i haven't seen such use cases in the codebase though.

navaneeth.suresh: ideally, that should be len(' (unresolved)'), right? i haven't seen such use cases in the…
ui.write(sname, label=namelabel) ui.write(sname, label=namelabel)
namelabel = 'shelve.name' namelabel = 'shelve.name'
if ui.quiet: if ui.quiet:
ui.write('\n') ui.write('\n')
continue continue
ui.write(' ' * (16 - len(sname))) ui.write(' ' * (namewidth - len(sname)))
used = 16 used = namewidth
date = dateutil.makedate(mtime) date = dateutil.makedate(mtime)
age = '(%s)' % templatefilters.age(date, abbrev=True) age = '(%s)' % templatefilters.age(date, abbrev=True)
ui.write(age, label='shelve.age') ui.write(age, label='shelve.age')
ui.write(' ' * (12 - len(age))) ui.write(' ' * (12 - len(age)))
used += 12 used += 12
with open(name + '.' + patchextension, 'rb') as fp: with open(name + '.' + patchextension, 'rb') as fp:
while True: while True:
line = fp.readline() line = fp.readline()
_('use the given name for the shelved commit'), _('NAME')), _('use the given name for the shelved commit'), _('NAME')),
('p', 'patch', None, ('p', 'patch', None,
_('output patches for changes (provide the names of the shelved ' _('output patches for changes (provide the names of the shelved '
'changes as positional arguments)')), 'changes as positional arguments)')),
('i', 'interactive', None, ('i', 'interactive', None,
_('interactive mode, only works while creating a shelve')), _('interactive mode, only works while creating a shelve')),
('', 'stat', None, ('', 'stat', None,
_('output diffstat-style summary of changes (provide the names of ' _('output diffstat-style summary of changes (provide the names of '
'the shelved changes as positional arguments)') 'the shelved changes as positional arguments)')),
('', 'unresolved', None,
_('unshelve mergestate with unresolved files')
)] + cmdutil.walkopts, )] + cmdutil.walkopts,
_('hg shelve [OPTION]... [FILE]...'), _('hg shelve [OPTION]... [FILE]...'),
helpcategory=command.CATEGORY_WORKING_DIRECTORY) helpcategory=command.CATEGORY_WORKING_DIRECTORY)
pulkitUnsubmitted
Done

nit: will be nice to keep )] + cmdutil.walkopts, to a new line. as it was before.

pulkit: nit: will be nice to keep `)] + cmdutil.walkopts,` to a new line. as it was before.
def shelvecmd(ui, repo, *pats, **opts): def shelvecmd(ui, repo, *pats, **opts):
'''save and set aside changes from the working directory '''save and set aside changes from the working directory
Shelving takes files that "hg status" reports as not clean, saves Shelving takes files that "hg status" reports as not clean, saves
the modifications to a bundle (a shelved change), and reverts the the modifications to a bundle (a shelved change), and reverts the
files so that their state in the working directory becomes clean. files so that their state in the working directory becomes clean.
To restore these changes to the working directory, using "hg To restore these changes to the working directory, using "hg

tests/test-shelve-unresolved.t

  • This file was added.
Test shelve with unresolved mergestate
$ cat >> $HGRCPATH <<EOF
> [extensions]
> shelve =
> EOF
$ hg init shelve-unresolved
$ cd shelve-unresolved
$ echo A >> file1
$ echo A >> file2
$ hg ci -Am A
adding file1
adding file2
$ echo foo >> bar
$ hg add bar
-- should abort on absence of mergestate
$ hg shelve --unresolved
abort: no active mergestate found
[255]
$ hg forget bar
$ echo B >> file1
$ echo B >> file2
$ hg ci -m B
$ hg up 0
2 files updated, 0 files merged, 0 files removed, 0 files unresolved
$ echo C >> file1
$ echo C >> file2
$ hg ci -m C
created new head
$ hg merge
merging file1
merging file2
warning: conflicts while merging file1! (edit, then use 'hg resolve --mark')
warning: conflicts while merging file2! (edit, then use 'hg resolve --mark')
0 files updated, 0 files merged, 0 files removed, 2 files unresolved
use 'hg resolve' to retry unresolved file merges or 'hg merge --abort' to abandon
[1]
-- let's partially solve the conflicts
$ cat > file1 <<EOF
> A
> B
> C
> EOF
$ hg resolve -m file1
-- mark file2 as resolved to check abort
$ hg resolve -m file2
(no more unresolved files)
$ hg log -G
@ changeset: 2:69004294ad57
| tag: tip
| parent: 0:c32ef6121744
| user: test
| date: Thu Jan 01 00:00:00 1970 +0000
| summary: C
|
| @ changeset: 1:fd9a4049234b
|/ user: test
| date: Thu Jan 01 00:00:00 1970 +0000
| summary: B
|
o changeset: 0:c32ef6121744
user: test
date: Thu Jan 01 00:00:00 1970 +0000
summary: A
$ cat file1
A
B
C
$ hg diff
diff -r 69004294ad57 file1
--- a/file1 Thu Jan 01 00:00:00 1970 +0000
+++ b/file1 Thu Jan 01 00:00:00 1970 +0000
@@ -1,2 +1,3 @@
A
+B
C
diff -r 69004294ad57 file2
--- a/file2 Thu Jan 01 00:00:00 1970 +0000
+++ b/file2 Thu Jan 01 00:00:00 1970 +0000
@@ -1,2 +1,6 @@
A
+<<<<<<< working copy: 69004294ad57 - test: C
C
+=======
+B
+>>>>>>> merge rev: fd9a4049234b - test: B
-- should abort on absence of conflicts
$ hg shelve
abort: mergestate found
try with --unresolved to shelve conflicts
[255]
$ hg shelve --unresolved
abort: no unresolved files found in the mergestate
[255]
$ hg resolve -u file2
$ hg resolve -l
R file1
U file2
-- should suggest --unresolved on shelving with mergestate
$ hg shelve
abort: mergestate found
try with --unresolved to shelve conflicts
[255]
$ hg shelve --unresolved
shelved as default
2 files updated, 0 files merged, 0 files removed, 0 files unresolved
$ cat file1
A
C
$ hg log -G
@ changeset: 2:69004294ad57
| tag: tip
| parent: 0:c32ef6121744
| user: test
| date: Thu Jan 01 00:00:00 1970 +0000
| summary: C
|
| o changeset: 1:fd9a4049234b
|/ user: test
| date: Thu Jan 01 00:00:00 1970 +0000
| summary: B
|
o changeset: 0:c32ef6121744
user: test
date: Thu Jan 01 00:00:00 1970 +0000
summary: A
$ hg shelve --list
default (unresolved) (1s ago) changes to: C
$ hg shelve --patch
default (unresolved) (1s ago) changes to: C
diff --git a/file1 b/file1
--- a/file1
+++ b/file1
@@ -1,2 +1,3 @@
A
+B
C
diff --git a/file2 b/file2
--- a/file2
+++ b/file2
@@ -1,2 +1,6 @@
A
+<<<<<<< working copy: 69004294ad57 - test: C
C
+=======
+B
+>>>>>>> merge rev: fd9a4049234b - test: B

tests/test-shelve.t

-m --message TEXT use text as shelve message -m --message TEXT use text as shelve message
-n --name NAME use the given name for the shelved commit -n --name NAME use the given name for the shelved commit
-p --patch output patches for changes (provide the names of the -p --patch output patches for changes (provide the names of the
shelved changes as positional arguments) shelved changes as positional arguments)
-i --interactive interactive mode, only works while creating a shelve -i --interactive interactive mode, only works while creating a shelve
--stat output diffstat-style summary of changes (provide --stat output diffstat-style summary of changes (provide
the names of the shelved changes as positional the names of the shelved changes as positional
arguments) arguments)
--unresolved unshelve mergestate with unresolved files
-I --include PATTERN [+] include names matching the given patterns -I --include PATTERN [+] include names matching the given patterns
-X --exclude PATTERN [+] exclude names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns
--mq operate on patch repository --mq operate on patch repository
(some details hidden, use --verbose to show complete help) (some details hidden, use --verbose to show complete help)
shelving in an empty repo should be possible shelving in an empty repo should be possible
(this tests also that editor is not invoked, if '--edit' is not (this tests also that editor is not invoked, if '--edit' is not