This is an archive of the discontinued Mercurial Phabricator instance.

Differential D4708

localrepo: support writing shared file (API)
ClosedPublic

Authored by indygreg on Sep 24 2018, 12:12 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHGd3d4b4b5f725: localrepo: support writing shared file (API)
Summary

Now that we can create a shared repository via creation options, we
can handle other special actions related to share at repo creation time
as well.

One of the things we do after creating a shared repository is write
out a .hg/shared file containing the list of additional things to
share. Of which only "bookmarks" is supported.

We add a creation option to hold the set of additional items to
share. If items are defined, we write out the .hg/shared file at
repo creation time.

As part of this, we no longer hold the repo lock when writing the
file. I'm pretty sure we don't care about the tiny race condition
window. I'm also pretty sure the reason we used the lock was because
the vfs auditor on the repo instance complained otherwise. Since the
repo creation code doesn't have an audited vfs, we don't need to
appease it.

Because we no longer need to tell the post share hook what items
are shared, the "bookmarks" argument to that function has been
dropped, incurring an API change.

Diff Detail

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

Event Timeline

indygreg created this revision.Sep 24 2018, 12:12 PM
Closed by commit rHGd3d4b4b5f725: localrepo: support writing shared file (API) (authored by indygreg). · Explain WhySep 26 2018, 1:23 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 11381

hgext/largefiles/overrides.py

if opts.get('all_largefiles'): if opts.get('all_largefiles'):
success, missing = lfcommands.downloadlfiles(ui, repo, None) success, missing = lfcommands.downloadlfiles(ui, repo, None)
if missing != 0: if missing != 0:
return None return None
return result return result
def hgpostshare(orig, sourcerepo, destrepo, bookmarks=True, defaultpath=None): def hgpostshare(orig, sourcerepo, destrepo, defaultpath=None):
orig(sourcerepo, destrepo, bookmarks, defaultpath) orig(sourcerepo, destrepo, defaultpath=defaultpath)
# If largefiles is required for this repo, permanently enable it locally # If largefiles is required for this repo, permanently enable it locally
if 'largefiles' in destrepo.requirements: if 'largefiles' in destrepo.requirements:
destrepo.vfs.append('hgrc', destrepo.vfs.append('hgrc',
util.tonativeeol('\n[extensions]\nlargefiles=\n')) util.tonativeeol('\n[extensions]\nlargefiles=\n'))
def overriderebase(orig, ui, repo, **opts): def overriderebase(orig, ui, repo, **opts):
if not util.safehasattr(repo, '_largefilesenabled'): if not util.safehasattr(repo, '_largefilesenabled'):

hgext/lfs/wrapper.py

# If lfs is required for this repo, permanently enable it locally # If lfs is required for this repo, permanently enable it locally
if 'lfs' in repo.requirements: if 'lfs' in repo.requirements:
repo.vfs.append('hgrc', repo.vfs.append('hgrc',
util.tonativeeol('\n[extensions]\nlfs=\n')) util.tonativeeol('\n[extensions]\nlfs=\n'))
return result return result
def hgpostshare(orig, sourcerepo, destrepo, bookmarks=True, defaultpath=None): def hgpostshare(orig, sourcerepo, destrepo, defaultpath=None):
orig(sourcerepo, destrepo, bookmarks, defaultpath) orig(sourcerepo, destrepo, defaultpath=defaultpath)
# If lfs is required for this repo, permanently enable it locally # If lfs is required for this repo, permanently enable it locally
if 'lfs' in destrepo.requirements: if 'lfs' in destrepo.requirements:
destrepo.vfs.append('hgrc', util.tonativeeol('\n[extensions]\nlfs=\n')) destrepo.vfs.append('hgrc', util.tonativeeol('\n[extensions]\nlfs=\n'))
def _prefetchfiles(repo, revs, match): def _prefetchfiles(repo, revs, match):
"""Ensure that required LFS blobs are present, fetching them as a group if """Ensure that required LFS blobs are present, fetching them as a group if
needed.""" needed."""

mercurial/hg.py

origsource = ui.expandpath(source) origsource = ui.expandpath(source)
source, branches = parseurl(origsource) source, branches = parseurl(origsource)
srcrepo = repository(ui, source) srcrepo = repository(ui, source)
rev, checkout = addbranchrevs(srcrepo, srcrepo, branches, None) rev, checkout = addbranchrevs(srcrepo, srcrepo, branches, None)
else: else:
srcrepo = source.local() srcrepo = source.local()
checkout = None checkout = None
shareditems = set()
if bookmarks:
shareditems.add(sharedbookmarks)
r = repository(ui, dest, create=True, createopts={ r = repository(ui, dest, create=True, createopts={
'sharedrepo': srcrepo, 'sharedrepo': srcrepo,
'sharedrelative': relative, 'sharedrelative': relative,
'shareditems': shareditems,
}) })
postshare(srcrepo, r, bookmarks=bookmarks, defaultpath=defaultpath) postshare(srcrepo, r, defaultpath=defaultpath)
_postshareupdate(r, update, checkout=checkout) _postshareupdate(r, update, checkout=checkout)
return r return r
def unshare(ui, repo): def unshare(ui, repo):
"""convert a shared repository to a normal one """convert a shared repository to a normal one
Copy the store data to the repo and remove the sharedpath data. Copy the store data to the repo and remove the sharedpath data.
subs = c.substate subs = c.substate
for s in sorted(subs): for s in sorted(subs):
c.sub(s).unshare() c.sub(s).unshare()
localrepo.poisonrepository(repo) localrepo.poisonrepository(repo)
return newrepo return newrepo
def postshare(sourcerepo, destrepo, bookmarks=True, defaultpath=None): def postshare(sourcerepo, destrepo, defaultpath=None):
"""Called after a new shared repo is created. """Called after a new shared repo is created.
The new repo only has a requirements file and pointer to the source. The new repo only has a requirements file and pointer to the source.
This function configures additional shared data. This function configures additional shared data.
Extensions can wrap this function and write additional entries to Extensions can wrap this function and write additional entries to
destrepo/.hg/shared to indicate additional pieces of data to be shared. destrepo/.hg/shared to indicate additional pieces of data to be shared.
""" """
default = defaultpath or sourcerepo.ui.config('paths', 'default') default = defaultpath or sourcerepo.ui.config('paths', 'default')
if default: if default:
template = ('[paths]\n' template = ('[paths]\n'
'default = %s\n') 'default = %s\n')
destrepo.vfs.write('hgrc', util.tonativeeol(template % default)) destrepo.vfs.write('hgrc', util.tonativeeol(template % default))
with destrepo.wlock():
if bookmarks:
destrepo.vfs.write('shared', sharedbookmarks + '\n')
def _postshareupdate(repo, update, checkout=None): def _postshareupdate(repo, update, checkout=None):
"""Maybe perform a working directory update after a shared repo is created. """Maybe perform a working directory update after a shared repo is created.
``update`` can be a boolean or a revision to update to. ``update`` can be a boolean or a revision to update to.
""" """
if not update: if not update:
return return

mercurial/localrepo.py

Extensions can wrap this function to filter out creation options Extensions can wrap this function to filter out creation options
they know how to handle. they know how to handle.
""" """
known = { known = {
'narrowfiles', 'narrowfiles',
'sharedrepo', 'sharedrepo',
'sharedrelative', 'sharedrelative',
'shareditems',
} }
return {k: v for k, v in createopts.items() if k not in known} return {k: v for k, v in createopts.items() if k not in known}
def createrepository(ui, path, createopts=None): def createrepository(ui, path, createopts=None):
"""Create a new repository in a vfs. """Create a new repository in a vfs.
``path`` path to the new repo's working directory. ``path`` path to the new repo's working directory.
``createopts`` options for the new repository. ``createopts`` options for the new repository.
The following keys for ``createopts`` are recognized: The following keys for ``createopts`` are recognized:
narrowfiles narrowfiles
Set up repository to support narrow file storage. Set up repository to support narrow file storage.
sharedrepo sharedrepo
Repository object from which storage should be shared. Repository object from which storage should be shared.
sharedrelative sharedrelative
Boolean indicating if the path to the shared repo should be Boolean indicating if the path to the shared repo should be
stored as relative. By default, the pointer to the "parent" repo stored as relative. By default, the pointer to the "parent" repo
is stored as an absolute path. is stored as an absolute path.
shareditems
Set of items to share to the new repository (in addition to storage).
""" """
createopts = createopts or {} createopts = createopts or {}
unknownopts = filterknowncreateopts(ui, createopts) unknownopts = filterknowncreateopts(ui, createopts)
if not isinstance(unknownopts, dict): if not isinstance(unknownopts, dict):
raise error.ProgrammingError('filterknowncreateopts() did not return ' raise error.ProgrammingError('filterknowncreateopts() did not return '
'a dict') 'a dict')
b'layout') b'layout')
scmutil.writerequires(hgvfs, requirements) scmutil.writerequires(hgvfs, requirements)
# Write out file telling readers where to find the shared store. # Write out file telling readers where to find the shared store.
if 'sharedrepo' in createopts: if 'sharedrepo' in createopts:
hgvfs.write(b'sharedpath', sharedpath) hgvfs.write(b'sharedpath', sharedpath)
if createopts.get('shareditems'):
shared = b'\n'.join(sorted(createopts['shareditems'])) + b'\n'
hgvfs.write(b'shared', shared)
def poisonrepository(repo): def poisonrepository(repo):
"""Poison a repository instance so it can no longer be used.""" """Poison a repository instance so it can no longer be used."""
# Perform any cleanup on the instance. # Perform any cleanup on the instance.
repo.close() repo.close()
# Our strategy is to replace the type of the object with one that # Our strategy is to replace the type of the object with one that
# has all attribute lookups result in error. # has all attribute lookups result in error.
# #