remotenames: add functionality to hoist remotebookmarks

This patch adds the functionality to hoist remotebookmarks to the top level
namespace. The peer of which bookmarks should be hoisted can be set using
`remotenames.hoistedpeer` config option. Only bookmarks can be hoisted. If a
hoisted name and local bookmark exists of the same name, the local bookmark
takes precedence.

While I was here, I documented the default values of two other remotenames
config options.

Differential Revision: https://phab.mercurial-scm.org/D2807

hgext/remotenames.py

@@ -1,305 +1,352 b''
 # remotenames.py - extension to display remotenames
 #
 # Copyright 2017 Augie Fackler <[e-mail]>
 # Copyright 2017 Sean Farley <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 """ showing remotebookmarks and remotebranches in UI
 
 By default both remotebookmarks and remotebranches are turned on. Config knob to
 control the individually are as follows.
 
 Config options to tweak the default behaviour:
 
 remotenames.bookmarks
-  Boolean value to enable or disable showing of remotebookmarks
+  Boolean value to enable or disable showing of remotebookmarks (default: True)
 
 remotenames.branches
-  Boolean value to enable or disable showing of remotebranches
+  Boolean value to enable or disable showing of remotebranches (default: True)
+
+remotenames.hoistedpeer
+  Name of the peer whose remotebookmarks should be hoisted into the top-level
+  namespace (default: 'default')
 """
 
 from __future__ import absolute_import
 
 from mercurial.i18n import _
 
 from mercurial.node import (
     bin,
 )
 from mercurial import (
     logexchange,
     namespaces,
     pycompat,
     registrar,
     revsetlang,
     smartset,
     templateutil,
 )
 
 if pycompat.ispy3:
     import collections.abc
     mutablemapping = collections.abc.MutableMapping
 else:
     import collections
     mutablemapping = collections.MutableMapping
 
 # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for
 # extensions which SHIP WITH MERCURIAL. Non-mainline extensions should
 # be specifying the version(s) of Mercurial they are tested with, or
 # leave the attribute unspecified.
 testedwith = 'ships-with-hg-core'
 
 configtable = {}
 configitem = registrar.configitem(configtable)
 templatekeyword = registrar.templatekeyword()
 revsetpredicate = registrar.revsetpredicate()
 
 configitem('remotenames', 'bookmarks',
     default=True,
 )
 configitem('remotenames', 'branches',
     default=True,
 )
+configitem('remotenames', 'hoistedpeer',
+    default='default',
+)
 
 class lazyremotenamedict(mutablemapping):
     """
     Read-only dict-like Class to lazily resolve remotename entries
 
     We are doing that because remotenames startup was slow.
     We lazily read the remotenames file once to figure out the potential entries
     and store them in self.potentialentries. Then when asked to resolve an
     entry, if it is not in self.potentialentries, then it isn't there, if it
     is in self.potentialentries we resolve it and store the result in
     self.cache. We cannot be lazy is when asked all the entries (keys).
     """
     def __init__(self, kind, repo):
         self.cache = {}
         self.potentialentries = {}
         self._kind = kind # bookmarks or branches
         self._repo = repo
         self.loaded = False
 
     def _load(self):
         """ Read the remotenames file, store entries matching selected kind """
         self.loaded = True
         repo = self._repo
         for node, rpath, rname in logexchange.readremotenamefile(repo,
                                                                 self._kind):
             name = rpath + '/' + rname
             self.potentialentries[name] = (node, rpath, name)
 
     def _resolvedata(self, potentialentry):
         """ Check that the node for potentialentry exists and return it """
         if not potentialentry in self.potentialentries:
             return None
         node, remote, name = self.potentialentries[potentialentry]
         repo = self._repo
         binnode = bin(node)
         # if the node doesn't exist, skip it
         try:
             repo.changelog.rev(binnode)
         except LookupError:
             return None
         # Skip closed branches
         if (self._kind == 'branches' and repo[binnode].closesbranch()):
             return None
         return [binnode]
 
     def __getitem__(self, key):
         if not self.loaded:
             self._load()
         val = self._fetchandcache(key)
         if val is not None:
             return val
         else:
             raise KeyError()
 
     def __iter__(self):
         return iter(self.potentialentries)
 
     def __len__(self):
         return len(self.potentialentries)
 
     def __setitem__(self):
         raise NotImplementedError
 
     def __delitem__(self):
         raise NotImplementedError
 
     def _fetchandcache(self, key):
         if key in self.cache:
             return self.cache[key]
         val = self._resolvedata(key)
         if val is not None:
             self.cache[key] = val
             return val
         else:
             return None
 
     def keys(self):
         """ Get a list of bookmark or branch names """
         if not self.loaded:
             self._load()
         return self.potentialentries.keys()
 
     def iteritems(self):
         """ Iterate over (name, node) tuples """
 
         if not self.loaded:
             self._load()
 
         for k, vtup in self.potentialentries.iteritems():
             yield (k, [bin(vtup[0])])
 
 class remotenames(object):
     """
     This class encapsulates all the remotenames state. It also contains
     methods to access that state in convenient ways. Remotenames are lazy
     loaded. Whenever client code needs to ensure the freshest copy of
     remotenames, use the `clearnames` method to force an eventual load.
     """
 
     def __init__(self, repo, *args):
         self._repo = repo
         self.clearnames()
 
     def clearnames(self):
         """ Clear all remote names state """
         self.bookmarks = lazyremotenamedict("bookmarks", self._repo)
         self.branches = lazyremotenamedict("branches", self._repo)
         self._invalidatecache()
 
     def _invalidatecache(self):
         self._nodetobmarks = None
         self._nodetobranch = None
+        self._hoisttonodes = None
+        self._nodetohoists = None
 
     def bmarktonodes(self):
         return self.bookmarks
 
     def nodetobmarks(self):
         if not self._nodetobmarks:
             bmarktonodes = self.bmarktonodes()
             self._nodetobmarks = {}
             for name, node in bmarktonodes.iteritems():
                 self._nodetobmarks.setdefault(node[0], []).append(name)
         return self._nodetobmarks
 
     def branchtonodes(self):
         return self.branches
 
     def nodetobranch(self):
         if not self._nodetobranch:
             branchtonodes = self.branchtonodes()
             self._nodetobranch = {}
             for name, nodes in branchtonodes.iteritems():
                 for node in nodes:
                     self._nodetobranch.setdefault(node, []).append(name)
         return self._nodetobranch
 
+    def hoisttonodes(self, hoist):
+        if not self._hoisttonodes:
+            marktonodes = self.bmarktonodes()
+            self._hoisttonodes = {}
+            hoist += '/'
+            for name, node in marktonodes.iteritems():
+                if name.startswith(hoist):
+                    name = name[len(hoist):]
+                    self._hoisttonodes[name] = node
+        return self._hoisttonodes
+
+    def nodetohoists(self, hoist):
+        if not self._nodetohoists:
+            marktonodes = self.bmarktonodes()
+            self._nodetohoists = {}
+            hoist += '/'
+            for name, node in marktonodes.iteritems():
+                if name.startswith(hoist):
+                    name = name[len(hoist):]
+                    self._nodetohoists.setdefault(node[0], []).append(name)
+        return self._nodetohoists
+
 def reposetup(ui, repo):
     if not repo.local():
         return
 
     repo._remotenames = remotenames(repo)
     ns = namespaces.namespace
 
     if ui.configbool('remotenames', 'bookmarks'):
         remotebookmarkns = ns(
             'remotebookmarks',
             templatename='remotebookmarks',
             colorname='remotebookmark',
             logfmt='remote bookmark:  %s\n',
             listnames=lambda repo: repo._remotenames.bmarktonodes().keys(),
             namemap=lambda repo, name:
                 repo._remotenames.bmarktonodes().get(name, []),
             nodemap=lambda repo, node:
                 repo._remotenames.nodetobmarks().get(node, []))
         repo.names.addnamespace(remotebookmarkns)
 
+        # hoisting only works if there are remote bookmarks
+        hoist = ui.config('remotenames', 'hoistedpeer')
+        if hoist:
+            hoistednamens = ns(
+                'hoistednames',
+                templatename='hoistednames',
+                colorname='hoistedname',
+                logfmt='hoisted name:  %s\n',
+                listnames = lambda repo:
+                    repo._remotenames.hoisttonodes(hoist).keys(),
+                namemap = lambda repo, name:
+                    repo._remotenames.hoisttonodes(hoist).get(name, []),
+                nodemap = lambda repo, node:
+                    repo._remotenames.nodetohoists(hoist).get(node, []))
+            repo.names.addnamespace(hoistednamens)
+
     if ui.configbool('remotenames', 'branches'):
         remotebranchns = ns(
             'remotebranches',
             templatename='remotebranches',
             colorname='remotebranch',
             logfmt='remote branch:  %s\n',
             listnames = lambda repo: repo._remotenames.branchtonodes().keys(),
             namemap = lambda repo, name:
                 repo._remotenames.branchtonodes().get(name, []),
             nodemap = lambda repo, node:
                 repo._remotenames.nodetobranch().get(node, []))
         repo.names.addnamespace(remotebranchns)
 
 @templatekeyword('remotenames', requires={'repo', 'ctx'})
 def remotenameskw(context, mapping):
     """List of strings. Remote names associated with the changeset."""
     repo = context.resource(mapping, 'repo')
     ctx = context.resource(mapping, 'ctx')
 
     remotenames = []
     if 'remotebookmarks' in repo.names:
         remotenames = repo.names['remotebookmarks'].names(repo, ctx.node())
 
     if 'remotebranches' in repo.names:
         remotenames += repo.names['remotebranches'].names(repo, ctx.node())
 
     return templateutil.compatlist(context, mapping, 'remotename', remotenames,
                                    plural='remotenames')
 
 @templatekeyword('remotebookmarks', requires={'repo', 'ctx'})
 def remotebookmarkskw(context, mapping):
     """List of strings. Remote bookmarks associated with the changeset."""
     repo = context.resource(mapping, 'repo')
     ctx = context.resource(mapping, 'ctx')
 
     remotebmarks = []
     if 'remotebookmarks' in repo.names:
         remotebmarks = repo.names['remotebookmarks'].names(repo, ctx.node())
 
     return templateutil.compatlist(context, mapping, 'remotebookmark',
                                    remotebmarks, plural='remotebookmarks')
 
 @templatekeyword('remotebranches', requires={'repo', 'ctx'})
 def remotebrancheskw(context, mapping):
     """List of strings. Remote branches associated with the changeset."""
     repo = context.resource(mapping, 'repo')
     ctx = context.resource(mapping, 'ctx')
 
     remotebranches = []
     if 'remotebranches' in repo.names:
         remotebranches = repo.names['remotebranches'].names(repo, ctx.node())
 
     return templateutil.compatlist(context, mapping, 'remotebranch',
                                    remotebranches, plural='remotebranches')
 
 def _revsetutil(repo, subset, x, rtypes):
     """utility function to return a set of revs based on the rtypes"""
 
     revs = set()
     cl = repo.changelog
     for rtype in rtypes:
         if rtype in repo.names:
             ns = repo.names[rtype]
             for name in ns.listnames(repo):
                 revs.update(ns.nodes(repo, name))
 
     results = (cl.rev(n) for n in revs if cl.hasnode(n))
     return subset & smartset.baseset(sorted(results))
 
 @revsetpredicate('remotenames()')
 def remotenamesrevset(repo, subset, x):
     """All changesets which have a remotename on them."""
     revsetlang.getargs(x, 0, 0, _("remotenames takes no arguments"))
     return _revsetutil(repo, subset, x, ('remotebookmarks', 'remotebranches'))
 
 @revsetpredicate('remotebranches()')
 def remotebranchesrevset(repo, subset, x):
     """All changesets which are branch heads on remotes."""
     revsetlang.getargs(x, 0, 0, _("remotebranches takes no arguments"))
     return _revsetutil(repo, subset, x, ('remotebranches',))
 
 @revsetpredicate('remotebookmarks()')
 def remotebmarksrevset(repo, subset, x):
     """All changesets which have bookmarks on remotes."""
     revsetlang.getargs(x, 0, 0, _("remotebookmarks takes no arguments"))
     return _revsetutil(repo, subset, x, ('remotebookmarks',))

tests/test-logexchange.t

@@ -1,261 +1,329 b''
 Testing the functionality to pull remotenames
 =============================================
 
   $ cat >> $HGRCPATH << EOF
   > [alias]
   > glog = log -G -T '{rev}:{node|short}  {desc}'
   > [experimental]
   > remotenames = True
   > [extensions]
   > remotenames =
   > show =
   > EOF
 
 Making a server repo
 --------------------
 
   $ hg init server
   $ cd server
   $ for ch in a b c d e f g h; do
   >   echo "foo" >> $ch
   >   hg ci -Aqm "Added "$ch
   > done
   $ hg glog
   @  7:ec2426147f0e  Added h
   |
   o  6:87d6d6676308  Added g
   |
   o  5:825660c69f0c  Added f
   |
   o  4:aa98ab95a928  Added e
   |
   o  3:62615734edd5  Added d
   |
   o  2:28ad74487de9  Added c
   |
   o  1:29becc82797a  Added b
   |
   o  0:18d04c59bb5d  Added a
   
   $ hg bookmark -r 3 foo
   $ hg bookmark -r 6 bar
   $ hg up 4
   0 files updated, 0 files merged, 3 files removed, 0 files unresolved
   $ hg branch wat
   marked working directory as branch wat
   (branches are permanent and global, did you want a bookmark?)
   $ echo foo >> bar
   $ hg ci -Aqm "added bar"
 
 Making a client repo
 --------------------
 
   $ cd ..
 
   $ hg clone server client
   updating to branch default
   8 files updated, 0 files merged, 0 files removed, 0 files unresolved
 
   $ cd client
   $ cat .hg/logexchange/bookmarks
   0
   
   87d6d66763085b629e6d7ed56778c79827273022\x00default\x00bar (esc)
   62615734edd52f06b6fb9c2beb429e4fe30d57b8\x00default\x00foo (esc)
 
   $ cat .hg/logexchange/branches
   0
   
   ec2426147f0e39dbc9cef599b066be6035ce691d\x00default\x00default (esc)
   3e1487808078543b0af6d10dadf5d46943578db0\x00default\x00wat (esc)
 
   $ hg show work
   o  3e14 (wat) (default/wat) added bar
   |
   ~
   @  ec24 (default/default) Added h
   |
   ~
 
   $ hg update "default/wat"
   1 files updated, 0 files merged, 3 files removed, 0 files unresolved
   $ hg identify
   3e1487808078 (wat) tip
 
 Making a new server
 -------------------
 
   $ cd ..
   $ hg init server2
   $ cd server2
   $ hg pull ../server/
   pulling from ../server/
   requesting all changes
   adding changesets
   adding manifests
   adding file changes
   added 9 changesets with 9 changes to 9 files (+1 heads)
   adding remote bookmark bar
   adding remote bookmark foo
   new changesets 18d04c59bb5d:3e1487808078
   (run 'hg heads' to see heads)
 
 Pulling form the new server
 ---------------------------
   $ cd ../client/
   $ hg pull ../server2/
   pulling from ../server2/
   searching for changes
   no changes found
   $ cat .hg/logexchange/bookmarks
   0
   
   62615734edd52f06b6fb9c2beb429e4fe30d57b8\x00default\x00foo (esc)
   87d6d66763085b629e6d7ed56778c79827273022\x00default\x00bar (esc)
   87d6d66763085b629e6d7ed56778c79827273022\x00$TESTTMP/server2\x00bar (esc)
   62615734edd52f06b6fb9c2beb429e4fe30d57b8\x00$TESTTMP/server2\x00foo (esc)
 
   $ cat .hg/logexchange/branches
   0
   
   3e1487808078543b0af6d10dadf5d46943578db0\x00default\x00wat (esc)
   ec2426147f0e39dbc9cef599b066be6035ce691d\x00default\x00default (esc)
   ec2426147f0e39dbc9cef599b066be6035ce691d\x00$TESTTMP/server2\x00default (esc)
   3e1487808078543b0af6d10dadf5d46943578db0\x00$TESTTMP/server2\x00wat (esc)
 
   $ hg log -G
   @  changeset:   8:3e1487808078
   |  branch:      wat
   |  tag:         tip
   |  remote branch:  $TESTTMP/server2/wat
   |  remote branch:  default/wat
   |  parent:      4:aa98ab95a928
   |  user:        test
   |  date:        Thu Jan 01 00:00:00 1970 +0000
   |  summary:     added bar
   |
   | o  changeset:   7:ec2426147f0e
   | |  remote branch:  $TESTTMP/server2/default
   | |  remote branch:  default/default
   | |  user:        test
   | |  date:        Thu Jan 01 00:00:00 1970 +0000
   | |  summary:     Added h
   | |
   | o  changeset:   6:87d6d6676308
   | |  bookmark:    bar
   | |  remote bookmark:  $TESTTMP/server2/bar
   | |  remote bookmark:  default/bar
+  | |  hoisted name:  bar
   | |  user:        test
   | |  date:        Thu Jan 01 00:00:00 1970 +0000
   | |  summary:     Added g
   | |
   | o  changeset:   5:825660c69f0c
   |/   user:        test
   |    date:        Thu Jan 01 00:00:00 1970 +0000
   |    summary:     Added f
   |
   o  changeset:   4:aa98ab95a928
   |  user:        test
   |  date:        Thu Jan 01 00:00:00 1970 +0000
   |  summary:     Added e
   |
   o  changeset:   3:62615734edd5
   |  bookmark:    foo
   |  remote bookmark:  $TESTTMP/server2/foo
   |  remote bookmark:  default/foo
+  |  hoisted name:  foo
   |  user:        test
   |  date:        Thu Jan 01 00:00:00 1970 +0000
   |  summary:     Added d
   |
   o  changeset:   2:28ad74487de9
   |  user:        test
   |  date:        Thu Jan 01 00:00:00 1970 +0000
   |  summary:     Added c
   |
   o  changeset:   1:29becc82797a
   |  user:        test
   |  date:        Thu Jan 01 00:00:00 1970 +0000
   |  summary:     Added b
   |
   o  changeset:   0:18d04c59bb5d
      user:        test
      date:        Thu Jan 01 00:00:00 1970 +0000
      summary:     Added a
   
 Testing the templates provided by remotenames extension
 
 `remotenames` keyword
 
   $ hg log -G -T "{rev}:{node|short} {remotenames}\n"
   @  8:3e1487808078 $TESTTMP/server2/wat default/wat
   |
   | o  7:ec2426147f0e $TESTTMP/server2/default default/default
   | |
   | o  6:87d6d6676308 $TESTTMP/server2/bar default/bar
   | |
   | o  5:825660c69f0c
   |/
   o  4:aa98ab95a928
   |
   o  3:62615734edd5 $TESTTMP/server2/foo default/foo
   |
   o  2:28ad74487de9
   |
   o  1:29becc82797a
   |
   o  0:18d04c59bb5d
   
 `remotebookmarks` and `remotebranches` keywords
 
   $ hg log -G -T "{rev}:{node|short} [{remotebookmarks}] ({remotebranches})"
   @  8:3e1487808078 [] ($TESTTMP/server2/wat default/wat)
   |
   | o  7:ec2426147f0e [] ($TESTTMP/server2/default default/default)
   | |
   | o  6:87d6d6676308 [$TESTTMP/server2/bar default/bar] ()
   | |
   | o  5:825660c69f0c [] ()
   |/
   o  4:aa98ab95a928 [] ()
   |
   o  3:62615734edd5 [$TESTTMP/server2/foo default/foo] ()
   |
   o  2:28ad74487de9 [] ()
   |
   o  1:29becc82797a [] ()
   |
   o  0:18d04c59bb5d [] ()
   
+The `hoistednames` template keyword
+
+  $ hg log -GT "{rev}:{node|short} ({hoistednames})"
+  @  8:3e1487808078 ()
+  |
+  | o  7:ec2426147f0e ()
+  | |
+  | o  6:87d6d6676308 (bar)
+  | |
+  | o  5:825660c69f0c ()
+  |/
+  o  4:aa98ab95a928 ()
+  |
+  o  3:62615734edd5 (foo)
+  |
+  o  2:28ad74487de9 ()
+  |
+  o  1:29becc82797a ()
+  |
+  o  0:18d04c59bb5d ()
+  
+
 Testing the revsets provided by remotenames extension
 
 `remotenames` revset
 
   $ hg log -r "remotenames()" -GT "{rev}:{node|short} {remotenames}\n"
   @  8:3e1487808078 $TESTTMP/server2/wat default/wat
   :
   : o  7:ec2426147f0e $TESTTMP/server2/default default/default
   : |
   : o  6:87d6d6676308 $TESTTMP/server2/bar default/bar
   :/
   o  3:62615734edd5 $TESTTMP/server2/foo default/foo
   |
   ~
 
 `remotebranches` revset
 
   $ hg log -r "remotebranches()" -GT "{rev}:{node|short} {remotenames}\n"
   @  8:3e1487808078 $TESTTMP/server2/wat default/wat
   |
   ~
   o  7:ec2426147f0e $TESTTMP/server2/default default/default
   |
   ~
 
 `remotebookmarks` revset
 
   $ hg log -r "remotebookmarks()" -GT "{rev}:{node|short} {remotenames}\n"
   o  6:87d6d6676308 $TESTTMP/server2/bar default/bar
   :
   o  3:62615734edd5 $TESTTMP/server2/foo default/foo
   |
   ~
+
+Updating to revision using hoisted name
+
+Deleting local bookmark to make sure we update to hoisted name only
+
+  $ hg bookmark -d bar
+
+  $ hg up bar
+  2 files updated, 0 files merged, 1 files removed, 0 files unresolved
+
+  $ hg log -r .
+  changeset:   6:87d6d6676308
+  remote bookmark:  $TESTTMP/server2/bar
+  remote bookmark:  default/bar
+  hoisted name:  bar
+  user:        test
+  date:        Thu Jan 01 00:00:00 1970 +0000
+  summary:     Added g
+  
+When both local bookmark and hoisted name exists but on different revs
+
+  $ hg up 8
+  1 files updated, 0 files merged, 2 files removed, 0 files unresolved
+
+  $ hg bookmark foo
+  moving bookmark 'foo' forward from 62615734edd5
+
+Local bookmark should take precedence over hoisted name
+
+  $ hg up foo
+  0 files updated, 0 files merged, 0 files removed, 0 files unresolved
+
+  $ hg log -r .
+  changeset:   8:3e1487808078
+  branch:      wat
+  bookmark:    foo
+  tag:         tip
+  remote branch:  $TESTTMP/server2/wat
+  remote branch:  default/wat
+  parent:      4:aa98ab95a928
+  user:        test
+  date:        Thu Jan 01 00:00:00 1970 +0000
+  summary:     added bar
+