( )⚙ D1548 remotenames: add functionality to store remotenames under .hg/hgremotenames/

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D1548

remotenames: add functionality to store remotenames under .hg/hgremotenames/
ClosedPublic

Authored by pulkit on Nov 29 2017, 4:57 PM.

Details

Reviewers
durin42
Group Reviewers
hg-reviewers
Commits
rHG8df8ce2cc5dd: remotenames: add functionality to store remotenames under .hg/hgremotenames/
Summary

This patch moves the functionality from remotenames extension to store
remotenames to core.

Storage format used by remotenames extension:

A single file .hg/remotenames with an entry in each line where each line is of
format:
node nametype remotepath/name
where nametype is either 'bookmarks' or 'branches'.

This was not the best way to store data, so while moving to core the storage
format was changed but yet not the final format. The storage format used by core
after this patch will be:

  • A file for each type of name i.e. bookmarks and branches in .hg/remotenames/ directory
  • A version number on the top of the file. The version for current format is 0.
  • An entry in each line where each line is of the format

node\0remotepath\0name

The logic to sync with existing remotenames file and saving journals and other
related things will be moved to core in next patches incrementally.

Thanks to Ryan, Augie and Durham for suggestions on storage format.

Previously reviewed as D939.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

pulkit created this revision.Nov 29 2017, 4:57 PM
dlax added a subscriber: dlax.Dec 1 2017, 3:23 AM
durin42 accepted this revision.Dec 5 2017, 5:17 PM
This revision is now accepted and ready to land.Dec 5 2017, 5:17 PM
Closed by commit rHG8df8ce2cc5dd: remotenames: add functionality to store remotenames under .hg/hgremotenames/ (authored by pulkit). · Explain WhyDec 5 2017, 5:23 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 3971

mercurial/remotenames.py

# remotenames.py # remotenames.py
# #
# Copyright 2017 Augie Fackler <augie@google.com> # Copyright 2017 Augie Fackler <augie@google.com>
# Copyright 2017 Sean Farley <sean@farley.io> # Copyright 2017 Sean Farley <sean@farley.io>
# #
# This software may be used and distributed according to the terms of the # This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version. # GNU General Public License version 2 or any later version.
from __future__ import absolute_import from __future__ import absolute_import
from .node import hex from .node import hex
from . import (
vfs as vfsmod,
)
# directory name in .hg/ in which remotenames files will be present
remotenamedir = 'remotenames'
def writeremotenamefile(repo, remotepath, names, nametype):
vfs = vfsmod.vfs(repo.vfs.join(remotenamedir))
f = vfs(nametype, 'w', atomictemp=True)
# write the storage version info on top of file
# version '0' represents the very initial version of the storage format
f.write('0\n\n')
for name, node in sorted(names.iteritems()):
if nametype == "branches":
for n in node:
f.write('%s\0%s\0%s\n' % (n, remotepath, name))
elif nametype == "bookmarks":
if node:
f.write('%s\0%s\0%s\n' % (node, remotepath, name))
f.close()
def saveremotenames(repo, remotepath, branches=None, bookmarks=None):
"""
save remotenames i.e. remotebookmarks and remotebranches in their
respective files under ".hg/remotenames/" directory.
"""
wlock = repo.wlock()
try:
if bookmarks:
writeremotenamefile(repo, remotepath, bookmarks, 'bookmarks')
if branches:
writeremotenamefile(repo, remotepath, branches, 'branches')
finally:
wlock.release()
def pullremotenames(localrepo, remoterepo): def pullremotenames(localrepo, remoterepo):
""" """
pulls bookmarks and branches information of the remote repo during a pulls bookmarks and branches information of the remote repo during a
pull or clone operation. pull or clone operation.
localrepo is our local repository localrepo is our local repository
remoterepo is the peer instance remoterepo is the peer instance
""" """
remotepath = remoterepo.url() remotepath = remoterepo.url()
bookmarks = remoterepo.listkeys('bookmarks') bookmarks = remoterepo.listkeys('bookmarks')
# on a push, we don't want to keep obsolete heads since # on a push, we don't want to keep obsolete heads since
# they won't show up as heads on the next pull, so we # they won't show up as heads on the next pull, so we
# remove them here otherwise we would require the user # remove them here otherwise we would require the user
# to issue a pull to refresh the storage # to issue a pull to refresh the storage
bmap = {} bmap = {}
repo = localrepo.unfiltered() repo = localrepo.unfiltered()
for branch, nodes in remoterepo.branchmap().iteritems(): for branch, nodes in remoterepo.branchmap().iteritems():
bmap[branch] = [] bmap[branch] = []
for node in nodes: for node in nodes:
if node in repo and not repo[node].obsolete(): if node in repo and not repo[node].obsolete():
bmap[branch].append(hex(node)) bmap[branch].append(hex(node))
# writing things to ui till the time we import the saving functionality saveremotenames(localrepo, remotepath, bmap, bookmarks)
ui = localrepo.ui
ui.write("\nRemotenames info\npath: %s\n" % remotepath)
ui.write("Bookmarks:\n")
for bm, node in bookmarks.iteritems():
ui.write("%s: %s\n" % (bm, node))
ui.write("Branches:\n")
for branch, node in bmap.iteritems():
ui.write("%s: %s\n" % (branch, node))
ui.write("\n")

tests/test-remotenames.t

requesting all changes requesting all changes
adding changesets adding changesets
adding manifests adding manifests
adding file changes adding file changes
added 9 changesets with 9 changes to 9 files (+1 heads) added 9 changesets with 9 changes to 9 files (+1 heads)
adding remote bookmark bar adding remote bookmark bar
adding remote bookmark foo adding remote bookmark foo
new changesets 18d04c59bb5d:3e1487808078 new changesets 18d04c59bb5d:3e1487808078
(run 'hg heads' to see heads)
Remotenames info $ cat .hg/remotenames/bookmarks
path: file:$TESTTMP/server 0
Bookmarks:
foo: 62615734edd52f06b6fb9c2beb429e4fe30d57b8
bar: 87d6d66763085b629e6d7ed56778c79827273022
Branches:
wat: ['3e1487808078543b0af6d10dadf5d46943578db0']
default: ['ec2426147f0e39dbc9cef599b066be6035ce691d']
(run 'hg heads' to see heads) 87d6d66763085b629e6d7ed56778c79827273022\x00file:$TESTTMP/server\x00bar (esc)
62615734edd52f06b6fb9c2beb429e4fe30d57b8\x00file:$TESTTMP/server\x00foo (esc)
$ cat .hg/remotenames/branches
0
ec2426147f0e39dbc9cef599b066be6035ce691d\x00file:$TESTTMP/server\x00default (esc)
3e1487808078543b0af6d10dadf5d46943578db0\x00file:$TESTTMP/server\x00wat (esc)