hgext/remotenames.py

branchmap-v3: filter topo heads using node for performance reason

The branchmap currently contains heads as nodeid. If we build a set of revnum
with the topological heads, we need to turn the nodeid in the branchmap to revnum to
be able to check if they are topo-heads. That nodeid → revnum lookup is
"expensive" and adds up to something noticeable if you do it hundreds of thousand
of time.

Instead we turn all the topo-heads revnums into nodes and build a set. So we can
directly test membership of the nodeids stored in the branchmap. That is much
faster.

Ideally we would have revnum in the branchmap and could directly test revnum
against a revnum set and that would be even faster. However that's an adventure
for another time.

Without this change, the branchmap format "v3" was significantly slower than the
"v2" format. With this changes, some of that gap is recovered

With rust + persistent nodemap, this overhead was smaller because the extra
lookup did not had to to build the nodemap from scratch.

In addition the mozilla-unified repository is able to use the "pure_top" mode of
branchmap v3, so it was not really affected by this.

Future changeset will work of the remaining of the performance gap.


### benchmark.name                                 = hg.command.unbundle
  # bin-env-vars.hg.py-re2-module                  = default
  # benchmark.variants.issue6528                   = disabled
  # benchmark.variants.resource-usage              = default
  # benchmark.variants.reuse-external-delta-parent = yes
  # benchmark.variants.revs                        = any-1-extra-rev
  # benchmark.variants.source                      = unbundle
  # benchmark.variants.validate                    = default
  # benchmark.variants.verbosity                   = quiet

 ## data-env-vars.name     = netbeans-2018-08-01-zstd-sparse-revlog
  # bin-env-vars.hg.flavor = default
branch-v2:        0.233711  ~~~~~
branch-v3 before: 0.380994  (+63.02%, +0.15)
branch-v3 after:  0.368769  (+57.79%, +0.14)
  # bin-env-vars.hg.flavor = rust
branch-v2:        0.235230  ~~~~~
branch-v3 before: 0.385060  (+63.70%, +0.15)
branch-v3 after:  0.372460  (+58.34%, +0.14)
 ## data-env-vars.name     = netbeans-2018-08-01-ds2-pnm
  # bin-env-vars.hg.flavor = rust
branch-v2:        0.255586  ~~~~~
branch-v3 before: 0.317524  (+24.23%, +0.06)
branch-v3 after:  0.318907  (+24.78%, +0.06)

 ## data-env-vars.name     = mozilla-central-2024-03-22-zstd-sparse-revlog
  # bin-env-vars.hg.flavor = default
branch-v2:        0.339010  ~~~~~
branch-v3 before: 0.410007  (+20.94%, +0.07)
branch-v3 after:  0.349752   (+3.17%, +0.01)
  # bin-env-vars.hg.flavor = rust
branch-v2:        0.346525  ~~~~~
branch-v3 before: 0.410428  (+18.44%, +0.06)
branch-v3 after:  0.354300   (+2.24%, +0.01)
 ## data-env-vars.name     = mozilla-central-2024-03-22-ds2-pnm
  # bin-env-vars.hg.flavor = rust
branch-v2:        0.380202  ~~~~~
branch-v3 before: 0.393871   (+3.60%, +0.01)
branch-v3 after:  0.396293   (+4.23%, +0.02)

 ## data-env-vars.name     = mozilla-unified-2024-03-22-zstd-sparse-revlog
  # bin-env-vars.hg.flavor = default
branch-v2:        0.412165  ~~~~~
branch-v3 before: 0.438105   (+6.29%, +0.03)
branch-v3 after:  0.424769   (+3.06%, +0.01)
  # bin-env-vars.hg.flavor = rust
branch-v2:        0.412397  ~~~~~
branch-v3 before: 0.438405   (+6.31%, +0.03)
branch-v3 after:  0.421796   (+2.28%, +0.01)
 ## data-env-vars.name     = mozilla-unified-2024-03-22-ds2-pnm
  # bin-env-vars.hg.flavor = rust
branch-v2:        0.429501  ~~~~~
branch-v3 before: 0.452692   (+5.40%, +0.02)
branch-v3 after:  0.443849   (+3.34%, +0.01)

 ## data-env-vars.name     = mozilla-try-2024-03-26-zstd-sparse-revlog
  # bin-env-vars.hg.flavor = default
branch-v2:        3.403171  ~~~~~
branch-v3 before: 6.562345  (+92.83%, +3.16)
branch-v3 after:  6.234055  (+83.18%, +2.83)
  # bin-env-vars.hg.flavor = rust
branch-v2:        3.454876  ~~~~~
branch-v3 before: 6.160248  (+78.31%, +2.71)
branch-v3 after:  6.307813  (+82.58%, +2.85)
 ## data-env-vars.name     = mozilla-try-2024-03-26-ds2-pnm
  # bin-env-vars.hg.flavor = rust
branch-v2:        3.465435  ~~~~~
branch-v3 before: 5.381648  (+55.30%, +1.92)
branch-v3 after:  5.176076  (+49.36%, +1.71)

# 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 (EXPERIMENTAL)

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 (default: True)

remotenames.branches
  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 annotations

import collections.abc

from mercurial.i18n import _

from mercurial.node import bin
from mercurial import (
    bookmarks,
    error,
    extensions,
    logexchange,
    namespaces,
    registrar,
    revsetlang,
    smartset,
    templateutil,
    util,
)

from mercurial.utils import stringutil

# 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 = b'ships-with-hg-core'

configtable = {}
configitem = registrar.configitem(configtable)
templatekeyword = registrar.templatekeyword()
revsetpredicate = registrar.revsetpredicate()

configitem(
    b'remotenames',
    b'bookmarks',
    default=True,
)
configitem(
    b'remotenames',
    b'branches',
    default=True,
)
configitem(
    b'remotenames',
    b'hoistedpeer',
    default=b'default',
)


class lazyremotenamedict(collections.abc.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 + b'/' + 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 == b'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, k, v):
        raise NotImplementedError

    def __delitem__(self, k):
        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.items():
            yield (k, [bin(vtup[0])])

    items = iteritems


class remotenames:
    """
    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(b"bookmarks", self._repo)
        self.branches = lazyremotenamedict(b"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.items():
                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.items():
                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 += b'/'
            for name, node in marktonodes.items():
                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 += b'/'
            for name, node in marktonodes.items():
                if name.startswith(hoist):
                    name = name[len(hoist) :]
                    self._nodetohoists.setdefault(node[0], []).append(name)
        return self._nodetohoists


def wrapprintbookmarks(orig, ui, repo, fm, bmarks):
    if b'remotebookmarks' not in repo.names:
        return
    ns = repo.names[b'remotebookmarks']

    for name in ns.listnames(repo):
        nodes = ns.nodes(repo, name)
        if not nodes:
            continue
        node = nodes[0]

        bmarks[name] = (node, b' ', b'')

    return orig(ui, repo, fm, bmarks)


def extsetup(ui):
    extensions.wrapfunction(bookmarks, '_printbookmarks', wrapprintbookmarks)


def reposetup(ui, repo):
    # set the config option to store remotenames
    repo.ui.setconfig(b'experimental', b'remotenames', True, b'remotenames-ext')

    if not repo.local():
        return

    repo._remotenames = remotenames(repo)
    ns = namespaces.namespace

    if ui.configbool(b'remotenames', b'bookmarks'):
        remotebookmarkns = ns(
            b'remotebookmarks',
            templatename=b'remotebookmarks',
            colorname=b'remotebookmark',
            logfmt=b'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(b'remotenames', b'hoistedpeer')
        if hoist:
            hoistednamens = ns(
                b'hoistednames',
                templatename=b'hoistednames',
                colorname=b'hoistedname',
                logfmt=b'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(b'remotenames', b'branches'):
        remotebranchns = ns(
            b'remotebranches',
            templatename=b'remotebranches',
            colorname=b'remotebranch',
            logfmt=b'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(b'remotenames', requires={b'repo', b'ctx'})
def remotenameskw(context, mapping):
    """List of strings. Remote names associated with the changeset."""
    repo = context.resource(mapping, b'repo')
    ctx = context.resource(mapping, b'ctx')

    remotenames = []
    if b'remotebookmarks' in repo.names:
        remotenames = repo.names[b'remotebookmarks'].names(repo, ctx.node())

    if b'remotebranches' in repo.names:
        remotenames += repo.names[b'remotebranches'].names(repo, ctx.node())

    return templateutil.compatlist(
        context, mapping, b'remotename', remotenames, plural=b'remotenames'
    )


@templatekeyword(b'remotebookmarks', requires={b'repo', b'ctx'})
def remotebookmarkskw(context, mapping):
    """List of strings. Remote bookmarks associated with the changeset."""
    repo = context.resource(mapping, b'repo')
    ctx = context.resource(mapping, b'ctx')

    remotebmarks = []
    if b'remotebookmarks' in repo.names:
        remotebmarks = repo.names[b'remotebookmarks'].names(repo, ctx.node())

    return templateutil.compatlist(
        context,
        mapping,
        b'remotebookmark',
        remotebmarks,
        plural=b'remotebookmarks',
    )


@templatekeyword(b'remotebranches', requires={b'repo', b'ctx'})
def remotebrancheskw(context, mapping):
    """List of strings. Remote branches associated with the changeset."""
    repo = context.resource(mapping, b'repo')
    ctx = context.resource(mapping, b'ctx')

    remotebranches = []
    if b'remotebranches' in repo.names:
        remotebranches = repo.names[b'remotebranches'].names(repo, ctx.node())

    return templateutil.compatlist(
        context,
        mapping,
        b'remotebranch',
        remotebranches,
        plural=b'remotebranches',
    )


def _revsetutil(repo, subset, x, rtypes):
    """utility function to return a set of revs based on the rtypes"""
    args = revsetlang.getargs(x, 0, 1, _(b'only one argument accepted'))
    if args:
        kind, pattern, matcher = stringutil.stringmatcher(
            revsetlang.getstring(args[0], _(b'argument must be a string'))
        )
    else:
        kind = pattern = None
        matcher = util.always

    nodes = set()
    cl = repo.changelog
    for rtype in rtypes:
        if rtype in repo.names:
            ns = repo.names[rtype]
            for name in ns.listnames(repo):
                if not matcher(name):
                    continue
                nodes.update(ns.nodes(repo, name))
    if kind == b'literal' and not nodes:
        raise error.RepoLookupError(
            _(b"remote name '%s' does not exist") % pattern
        )

    revs = (cl.rev(n) for n in nodes if cl.hasnode(n))
    return subset & smartset.baseset(revs)


@revsetpredicate(b'remotenames([name])')
def remotenamesrevset(repo, subset, x):
    """All changesets which have a remotename on them. If `name` is
    specified, only remotenames of matching remote paths are considered.

    Pattern matching is supported for `name`. See :hg:`help revisions.patterns`.
    """
    return _revsetutil(repo, subset, x, (b'remotebookmarks', b'remotebranches'))


@revsetpredicate(b'remotebranches([name])')
def remotebranchesrevset(repo, subset, x):
    """All changesets which are branch heads on remotes. If `name` is
    specified, only remotenames of matching remote paths are considered.

    Pattern matching is supported for `name`. See :hg:`help revisions.patterns`.
    """
    return _revsetutil(repo, subset, x, (b'remotebranches',))


@revsetpredicate(b'remotebookmarks([name])')
def remotebmarksrevset(repo, subset, x):
    """All changesets which have bookmarks on remotes. If `name` is
    specified, only remotenames of matching remote paths are considered.

    Pattern matching is supported for `name`. See :hg:`help revisions.patterns`.
    """
    return _revsetutil(repo, subset, x, (b'remotebookmarks',))