This is an archive of the discontinued Mercurial Phabricator instance.

Differential D2807

remotenames: add functionality to hoist remotebookmarks
ClosedPublic

Authored by pulkit on Mar 11 2018, 9:16 AM.

Details

Reviewers
durin42
indygreg
Group Reviewers
hg-reviewers
Commits
rHG9938992c5bae: remotenames: add functionality to hoist remotebookmarks
Summary

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.

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

pulkit created this revision.Mar 11 2018, 9:16 AM
durin42 accepted this revision as: durin42.Mar 12 2018, 5:39 PM
durin42 added a subscriber: durin42.

Seems fine, I'd like to hear what others think?

I'm not sure I'm crazy about "hoistedname" I guess.

pulkit updated this revision to Diff 7101.Mar 19 2018, 4:35 AM
pulkit added a comment.Mar 20 2018, 9:20 AM

A gentle reminder to get this series reviewed.

indygreg added a subscriber: indygreg.Mar 21 2018, 8:10 PM

I like the functionality. I'm not crazy about "hoist." I think if the config option were named hoistedpeer, that would be a bit better. If it is just hoist, it sounds like it should be a boolean.

hoistedname appearing in hg log output doesn't feel right. It seems to want a multiple word label. If we kept "hoist," I suppose that would be hoisted name. But I'm not crazy about the naming. But I can't think of better terminology right now. I want to incorporate "primary" or "main" somehow. But that terminology doesn't seem to work in the context of an hg log label.

With those minor fixups, I'll queue this. I think we can bikeshed the naming later. We can always alias the old config option if we rename things.

pulkit edited the summary of this revision. (Show Details)Mar 22 2018, 3:34 AM
pulkit updated this revision to Diff 7247.
indygreg accepted this revision.Mar 23 2018, 2:41 PM

I still don't have a good suggestion for a better name. We can always change terminology later.

This revision is now accepted and ready to land.Mar 23 2018, 2:41 PM
Closed by commit rHG9938992c5bae: remotenames: add functionality to hoist remotebookmarks (authored by pulkit). · Explain WhyMar 23 2018, 2:45 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mhgext/remotenames.py (51 lines)
Mtests/test-logexchange.t (68 lines)

Diff 7259

hgext/remotenames.py

# remotenames.py - extension to display remotenames # remotenames.py - extension to display remotenames
# #
# Copyright 2017 Augie Fackler <raf@durin42.com> # Copyright 2017 Augie Fackler <raf@durin42.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.
""" showing remotebookmarks and remotebranches in UI """ showing remotebookmarks and remotebranches in UI
By default both remotebookmarks and remotebranches are turned on. Config knob to By default both remotebookmarks and remotebranches are turned on. Config knob to
control the individually are as follows. control the individually are as follows.
Config options to tweak the default behaviour: Config options to tweak the default behaviour:
remotenames.bookmarks remotenames.bookmarks
Boolean value to enable or disable showing of remotebookmarks Boolean value to enable or disable showing of remotebookmarks (default: True)
remotenames.branches 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 __future__ import absolute_import
from mercurial.i18n import _ from mercurial.i18n import _
from mercurial.node import ( from mercurial.node import (
bin, bin,
revsetpredicate = registrar.revsetpredicate() revsetpredicate = registrar.revsetpredicate()
configitem('remotenames', 'bookmarks', configitem('remotenames', 'bookmarks',
default=True, default=True,
) )
configitem('remotenames', 'branches', configitem('remotenames', 'branches',
default=True, default=True,
) )
configitem('remotenames', 'hoistedpeer',
default='default',
)
class lazyremotenamedict(mutablemapping): class lazyremotenamedict(mutablemapping):
""" """
Read-only dict-like Class to lazily resolve remotename entries Read-only dict-like Class to lazily resolve remotename entries
We are doing that because remotenames startup was slow. We are doing that because remotenames startup was slow.
We lazily read the remotenames file once to figure out the potential entries 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 and store them in self.potentialentries. Then when asked to resolve an
""" Clear all remote names state """ """ Clear all remote names state """
self.bookmarks = lazyremotenamedict("bookmarks", self._repo) self.bookmarks = lazyremotenamedict("bookmarks", self._repo)
self.branches = lazyremotenamedict("branches", self._repo) self.branches = lazyremotenamedict("branches", self._repo)
self._invalidatecache() self._invalidatecache()
def _invalidatecache(self): def _invalidatecache(self):
self._nodetobmarks = None self._nodetobmarks = None
self._nodetobranch = None self._nodetobranch = None
self._hoisttonodes = None
self._nodetohoists = None
def bmarktonodes(self): def bmarktonodes(self):
return self.bookmarks return self.bookmarks
def nodetobmarks(self): def nodetobmarks(self):
if not self._nodetobmarks: if not self._nodetobmarks:
bmarktonodes = self.bmarktonodes() bmarktonodes = self.bmarktonodes()
self._nodetobmarks = {} self._nodetobmarks = {}
for name, node in bmarktonodes.iteritems(): for name, node in bmarktonodes.iteritems():
self._nodetobmarks.setdefault(node[0], []).append(name) self._nodetobmarks.setdefault(node[0], []).append(name)
return self._nodetobmarks return self._nodetobmarks
def branchtonodes(self): def branchtonodes(self):
return self.branches return self.branches
def nodetobranch(self): def nodetobranch(self):
if not self._nodetobranch: if not self._nodetobranch:
branchtonodes = self.branchtonodes() branchtonodes = self.branchtonodes()
self._nodetobranch = {} self._nodetobranch = {}
for name, nodes in branchtonodes.iteritems(): for name, nodes in branchtonodes.iteritems():
for node in nodes: for node in nodes:
self._nodetobranch.setdefault(node, []).append(name) self._nodetobranch.setdefault(node, []).append(name)
return self._nodetobranch 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): def reposetup(ui, repo):
if not repo.local(): if not repo.local():
return return
repo._remotenames = remotenames(repo) repo._remotenames = remotenames(repo)
ns = namespaces.namespace ns = namespaces.namespace
if ui.configbool('remotenames', 'bookmarks'): if ui.configbool('remotenames', 'bookmarks'):
remotebookmarkns = ns( remotebookmarkns = ns(
'remotebookmarks', 'remotebookmarks',
templatename='remotebookmarks', templatename='remotebookmarks',
colorname='remotebookmark', colorname='remotebookmark',
logfmt='remote bookmark: %s\n', logfmt='remote bookmark: %s\n',
listnames=lambda repo: repo._remotenames.bmarktonodes().keys(), listnames=lambda repo: repo._remotenames.bmarktonodes().keys(),
namemap=lambda repo, name: namemap=lambda repo, name:
repo._remotenames.bmarktonodes().get(name, []), repo._remotenames.bmarktonodes().get(name, []),
nodemap=lambda repo, node: nodemap=lambda repo, node:
repo._remotenames.nodetobmarks().get(node, [])) repo._remotenames.nodetobmarks().get(node, []))
repo.names.addnamespace(remotebookmarkns) 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'): if ui.configbool('remotenames', 'branches'):
remotebranchns = ns( remotebranchns = ns(
'remotebranches', 'remotebranches',
templatename='remotebranches', templatename='remotebranches',
colorname='remotebranch', colorname='remotebranch',
logfmt='remote branch: %s\n', logfmt='remote branch: %s\n',
listnames = lambda repo: repo._remotenames.branchtonodes().keys(), listnames = lambda repo: repo._remotenames.branchtonodes().keys(),
namemap = lambda repo, name: namemap = lambda repo, name:

tests/test-logexchange.t

| | user: test | | user: test
| | date: Thu Jan 01 00:00:00 1970 +0000 | | date: Thu Jan 01 00:00:00 1970 +0000
| | summary: Added h | | summary: Added h
| | | |
| o changeset: 6:87d6d6676308 | o changeset: 6:87d6d6676308
| | bookmark: bar | | bookmark: bar
| | remote bookmark: $TESTTMP/server2/bar | | remote bookmark: $TESTTMP/server2/bar
| | remote bookmark: default/bar | | remote bookmark: default/bar
| | hoisted name: bar
| | user: test | | user: test
| | date: Thu Jan 01 00:00:00 1970 +0000 | | date: Thu Jan 01 00:00:00 1970 +0000
| | summary: Added g | | summary: Added g
| | | |
| o changeset: 5:825660c69f0c | o changeset: 5:825660c69f0c
|/ user: test |/ user: test
| date: Thu Jan 01 00:00:00 1970 +0000 | date: Thu Jan 01 00:00:00 1970 +0000
| summary: Added f | summary: Added f
| |
o changeset: 4:aa98ab95a928 o changeset: 4:aa98ab95a928
| user: test | user: test
| date: Thu Jan 01 00:00:00 1970 +0000 | date: Thu Jan 01 00:00:00 1970 +0000
| summary: Added e | summary: Added e
| |
o changeset: 3:62615734edd5 o changeset: 3:62615734edd5
| bookmark: foo | bookmark: foo
| remote bookmark: $TESTTMP/server2/foo | remote bookmark: $TESTTMP/server2/foo
| remote bookmark: default/foo | remote bookmark: default/foo
| hoisted name: foo
| user: test | user: test
| date: Thu Jan 01 00:00:00 1970 +0000 | date: Thu Jan 01 00:00:00 1970 +0000
| summary: Added d | summary: Added d
| |
o changeset: 2:28ad74487de9 o changeset: 2:28ad74487de9
| user: test | user: test
| date: Thu Jan 01 00:00:00 1970 +0000 | date: Thu Jan 01 00:00:00 1970 +0000
| summary: Added c | summary: Added c
o 3:62615734edd5 [$TESTTMP/server2/foo default/foo] () o 3:62615734edd5 [$TESTTMP/server2/foo default/foo] ()
| |
o 2:28ad74487de9 [] () o 2:28ad74487de9 [] ()
| |
o 1:29becc82797a [] () o 1:29becc82797a [] ()
| |
o 0:18d04c59bb5d [] () 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 Testing the revsets provided by remotenames extension
`remotenames` revset `remotenames` revset
$ hg log -r "remotenames()" -GT "{rev}:{node|short} {remotenames}\n" $ hg log -r "remotenames()" -GT "{rev}:{node|short} {remotenames}\n"
@ 8:3e1487808078 $TESTTMP/server2/wat default/wat @ 8:3e1487808078 $TESTTMP/server2/wat default/wat
: :
: o 7:ec2426147f0e $TESTTMP/server2/default default/default : o 7:ec2426147f0e $TESTTMP/server2/default default/default
`remotebookmarks` revset `remotebookmarks` revset
$ hg log -r "remotebookmarks()" -GT "{rev}:{node|short} {remotenames}\n" $ hg log -r "remotebookmarks()" -GT "{rev}:{node|short} {remotenames}\n"
o 6:87d6d6676308 $TESTTMP/server2/bar default/bar o 6:87d6d6676308 $TESTTMP/server2/bar default/bar
: :
o 3:62615734edd5 $TESTTMP/server2/foo default/foo 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