Mercurial > hg
view mercurial/exthelper.py @ 48687:f8f2ecdde4b5
branchmap: skip obsolete revisions while computing heads
It's time to make this part of core Mercurial obsolescence-aware.
Not considering obsolete revisions when computing heads is clearly what
Mercurial should do. But there are a couple of small issues:
- Let's say tip of the repo is obsolete. There are two ways of finding tiprev
for branchcache (both are in use): looking at input data for update() and
looking at computed heads after update(). Previously, repo tip would be
tiprev of the branchcache. With this patch, an obsolete revision can no
longer be tiprev. And depending on what way we use for finding tiprev (input
data vs computed heads) we'll get a different result. This is relevant when
recomputing cache key from cache contents, and may lead to updating cache for
obsolete revisions multiple times (not from scratch, because it still would
be considered valid for a subset of revisions in the repo).
- If all commits on a branch are obsolete, the branchcache will include that
branch, but the list of heads will be empty (that's why there's now `if not
heads` when recomputing tiprev/tipnode from cache contents). Having an entry
for every branch is currently required for notify extension (and
test-notify.t to pass), because notify doesn't handle revsets in its
subscription config very well and will throw an error if e.g. a branch
doesn't exist.
- Cloning static HTTP repos may try to stat() a non-existent obsstore file. The
issue is that we now care about obsolescence during clone, but statichttpvfs
doesn't implement a stat method, so a regular vfs.stat() is used, and it
assumes that file is local and calls os.stat(). During a clone, we're trying
to stat() .hg/store/obsstore, but in static HTTP case we provide a literal
URL to the obsstore file on the remote as if it were a local file path. On
windows it actually results in a failure in test-static-http.t.
The first issue is going to be addressed in a series dedicated to making sure
branchcache is properly and timely written on disk (it wasn't perfect even
before this patch, but there aren't enough tests to demonstrate that). The
second issue will be addressed in a future patch for notify extension that will
make it not raise an exception if a branch doesn't exist. And the third one was
partially addressed in the previous patch in this series and will be properly
fixed in a future patch when this series is accepted.
filteredhash() grows a keyword argument to make sure that branchcache is also
invalidated when there are new obsolete revisions in its repo view. This way
the on-disk cache format is unchanged and compatible between versions (although
it will obviously be recomputed when switching versions before/after this patch
and the repo has obsolete revisions).
There's one test that uses plain `hg up` without arguments while updated to a
pruned commit. To make this test pass, simply return current working directory
parent. Later in this series this code will be replaced by what prune command
does: updating to the closest non-obsolete ancestor.
Test changes:
test-branch-change.t: update branch head and cache update message. The head of
default listed in hg heads is changed because revision 2 was rewritten as 7,
and 1 is the closest ancestor on the same branch, so it's the head of default
now.
The cache invalidation message appears now because of the cache hash change,
since we're now accounting for obsolete revisions. Here's some context:
"served.hidden" repo filter means everything is visible (no filtered
revisions), so before this series branch2-served.hidden file would not contain
any cache hash, only revnum and node. Now it also has a hash when there are
obsolete changesets in the repo. The command that the message appears for is
changing branch of 5 and 6, which are now obsolete, so the cache hash changes.
In general, when cache is simply out-of-date, it can be updated using the old
version as a base. But if cache hash differs, then the cache for that
particular repo filter is recomputed (at least with the current
implementation). This is what happens here.
test-obsmarker-template.t: the pull reports 2 heads changed, but after that the
repo correctly sees only 1. The new message could be better, but it's still an
improvement over the previous one where hg pull suggested merging with an
obsolete revision.
test-obsolete.t: we can see these revisions in hg log --hidden, but they
shouldn't be considered heads even with --hidden.
test-rebase-obsolete{,2}.t: there were new heads created previously after
making new orphan changesets, but they weren't detected. Now we are properly
detecting and reporting them.
test-rebase-obsolete4.t: there's only one head now because the other head is
pruned and was falsely reported before.
test-static-http.t: add obsstore to the list of requested files. This file
doesn't exist on the remotes, but clients want it anyway (they get 404). This
is fine, because there are other nonexistent files that clients request, like
.hg/bookmarks or .hg/cache/tags2-served.
Differential Revision: https://phab.mercurial-scm.org/D12097
author | Anton Shestakov <av6@dwimlabs.net> |
---|---|
date | Fri, 07 Jan 2022 11:53:23 +0300 |
parents | 887f89b100ac |
children | 6000f5b25c9b |
line wrap: on
line source
# Copyright 2012 Logilab SA <contact@logilab.fr> # Pierre-Yves David <pierre-yves.david@ens-lyon.org> # Octobus <contact@octobus.net> # # This software may be used and distributed according to the terms of the # GNU General Public License version 2 or any later version. ##################################################################### ### Extension helper ### ##################################################################### from __future__ import absolute_import from . import ( commands, error, extensions, pycompat, registrar, ) from hgdemandimport import tracing class exthelper(object): """Helper for modular extension setup A single helper should be instantiated for each module of an extension, where a command or function needs to be wrapped, or a command, extension hook, fileset, revset or template needs to be registered. Helper methods are then used as decorators for these various purposes. If an extension spans multiple modules, all helper instances should be merged in the main module. All decorators return the original function and may be chained. Aside from the helper functions with examples below, several registrar method aliases are available for adding commands, configitems, filesets, revsets, and templates. Simply decorate the appropriate methods, and assign the corresponding exthelper variable to a module level variable of the extension. The extension loading mechanism will handle the rest. example:: # ext.py eh = exthelper.exthelper() # As needed (failure to do this will mean your registration will not # happen): cmdtable = eh.cmdtable configtable = eh.configtable filesetpredicate = eh.filesetpredicate revsetpredicate = eh.revsetpredicate templatekeyword = eh.templatekeyword # As needed (failure to do this will mean your eh.wrap*-decorated # functions will not wrap, and/or your eh.*setup-decorated functions # will not execute): uisetup = eh.finaluisetup extsetup = eh.finalextsetup reposetup = eh.finalreposetup uipopulate = eh.finaluipopulate @eh.command(b'mynewcommand', [(b'r', b'rev', [], _(b'operate on these revisions'))], _(b'-r REV...'), helpcategory=command.CATEGORY_XXX) def newcommand(ui, repo, *revs, **opts): # implementation goes here eh.configitem(b'experimental', b'foo', default=False, ) @eh.filesetpredicate(b'lfs()') def filesetbabar(mctx, x): return mctx.predicate(...) @eh.revsetpredicate(b'hidden') def revsetbabar(repo, subset, x): args = revset.getargs(x, 0, 0, b'babar accept no argument') return [r for r in subset if b'babar' in repo[r].description()] @eh.templatekeyword(b'babar') def kwbabar(ctx): return b'babar' """ def __init__(self): self._uipopulatecallables = [] self._uicallables = [] self._extcallables = [] self._repocallables = [] self._commandwrappers = [] self._extcommandwrappers = [] self._functionwrappers = [] self.cmdtable = {} self.command = registrar.command(self.cmdtable) self.configtable = {} self.configitem = registrar.configitem(self.configtable) self.filesetpredicate = registrar.filesetpredicate() self.revsetpredicate = registrar.revsetpredicate() self.templatekeyword = registrar.templatekeyword() def merge(self, other): self._uicallables.extend(other._uicallables) self._uipopulatecallables.extend(other._uipopulatecallables) self._extcallables.extend(other._extcallables) self._repocallables.extend(other._repocallables) self.filesetpredicate._merge(other.filesetpredicate) self.revsetpredicate._merge(other.revsetpredicate) self.templatekeyword._merge(other.templatekeyword) self._commandwrappers.extend(other._commandwrappers) self._extcommandwrappers.extend(other._extcommandwrappers) self._functionwrappers.extend(other._functionwrappers) self.cmdtable.update(other.cmdtable) for section, items in pycompat.iteritems(other.configtable): if section in self.configtable: self.configtable[section].update(items) else: self.configtable[section] = items def finaluisetup(self, ui): """Method to be used as the extension uisetup The following operations belong here: - Changes to ui.__class__ . The ui object that will be used to run the command has not yet been created. Changes made here will affect ui objects created after this, and in particular the ui that will be passed to runcommand - Command wraps (extensions.wrapcommand) - Changes that need to be visible to other extensions: because initialization occurs in phases (all extensions run uisetup, then all run extsetup), a change made here will be visible to other extensions during extsetup - Monkeypatch or wrap function (extensions.wrapfunction) of dispatch module members - Setup of pre-* and post-* hooks - pushkey setup """ for command, wrapper, opts in self._commandwrappers: entry = extensions.wrapcommand(commands.table, command, wrapper) if opts: for opt in opts: entry[1].append(opt) for cont, funcname, wrapper in self._functionwrappers: extensions.wrapfunction(cont, funcname, wrapper) for c in self._uicallables: with tracing.log('finaluisetup: %s', repr(c)): c(ui) def finaluipopulate(self, ui): """Method to be used as the extension uipopulate This is called once per ui instance to: - Set up additional ui members - Update configuration by ``ui.setconfig()`` - Extend the class dynamically """ for c in self._uipopulatecallables: c(ui) def finalextsetup(self, ui): """Method to be used as the extension extsetup The following operations belong here: - Changes depending on the status of other extensions. (if extensions.find(b'mq')) - Add a global option to all commands """ knownexts = {} for ext, command, wrapper, opts in self._extcommandwrappers: if ext not in knownexts: try: e = extensions.find(ext) except KeyError: # Extension isn't enabled, so don't bother trying to wrap # it. continue knownexts[ext] = e.cmdtable entry = extensions.wrapcommand(knownexts[ext], command, wrapper) if opts: for opt in opts: entry[1].append(opt) for c in self._extcallables: with tracing.log('finalextsetup: %s', repr(c)): c(ui) def finalreposetup(self, ui, repo): """Method to be used as the extension reposetup The following operations belong here: - All hooks but pre-* and post-* - Modify configuration variables - Changes to repo.__class__, repo.dirstate.__class__ """ for c in self._repocallables: with tracing.log('finalreposetup: %s', repr(c)): c(ui, repo) def uisetup(self, call): """Decorated function will be executed during uisetup example:: # Required, otherwise your uisetup function(s) will not execute. uisetup = eh.finaluisetup @eh.uisetup def setupbabar(ui): print('this is uisetup!') """ self._uicallables.append(call) return call def uipopulate(self, call): """Decorated function will be executed during uipopulate example:: # Required, otherwise your uipopulate function(s) will not execute. uipopulate = eh.finaluipopulate @eh.uipopulate def setupfoo(ui): print('this is uipopulate!') """ self._uipopulatecallables.append(call) return call def extsetup(self, call): """Decorated function will be executed during extsetup example:: # Required, otherwise your extsetup function(s) will not execute. extsetup = eh.finalextsetup @eh.extsetup def setupcelestine(ui): print('this is extsetup!') """ self._extcallables.append(call) return call def reposetup(self, call): """Decorated function will be executed during reposetup example:: # Required, otherwise your reposetup function(s) will not execute. reposetup = eh.finalreposetup @eh.reposetup def setupzephir(ui, repo): print('this is reposetup!') """ self._repocallables.append(call) return call def wrapcommand(self, command, extension=None, opts=None): """Decorated function is a command wrapper The name of the command must be given as the decorator argument. The wrapping is installed during `uisetup`. If the second option `extension` argument is provided, the wrapping will be applied in the extension commandtable. This argument must be a string that will be searched using `extension.find` if not found and Abort error is raised. If the wrapping applies to an extension, it is installed during `extsetup`. example:: # Required if `extension` is not provided uisetup = eh.finaluisetup # Required if `extension` is provided extsetup = eh.finalextsetup @eh.wrapcommand(b'summary') def wrapsummary(orig, ui, repo, *args, **kwargs): ui.note(b'Barry!') return orig(ui, repo, *args, **kwargs) The `opts` argument allows specifying a list of tuples for additional arguments for the command. See ``mercurial.fancyopts.fancyopts()`` for the format of the tuple. """ if opts is None: opts = [] else: for opt in opts: if not isinstance(opt, tuple): raise error.ProgrammingError(b'opts must be list of tuples') if len(opt) not in (4, 5): msg = b'each opt tuple must contain 4 or 5 values' raise error.ProgrammingError(msg) def dec(wrapper): if extension is None: self._commandwrappers.append((command, wrapper, opts)) else: self._extcommandwrappers.append( (extension, command, wrapper, opts) ) return wrapper return dec def wrapfunction(self, container, funcname): """Decorated function is a function wrapper This function takes two arguments, the container and the name of the function to wrap. The wrapping is performed during `uisetup`. (there is no extension support) example:: # Required, otherwise the function will not be wrapped uisetup = eh.finaluisetup @eh.wrapfunction(discovery, b'checkheads') def wrapcheckheads(orig, *args, **kwargs): ui.note(b'His head smashed in and his heart cut out') return orig(*args, **kwargs) """ def dec(wrapper): self._functionwrappers.append((container, funcname, wrapper)) return wrapper return dec