Commit cc7940ca authored by Gregory Szorc's avatar Gregory Szorc
Browse files

registrar: replace "cmdtype" with an intent-based mechanism (API)

Commands perform varied actions and repositories vary in their

Historically, the .hg/requires file has been used to lock out clients
lacking a requirement. But this is a very heavy-handed approach and
is typically reserved for cases where the on-disk storage format
changes and we want to prevent incompatible clients from operating on
a repo.

Outside of the .hg/requires file, we tend to deal with things like
optional, extension-provided features via checking at call sites.
We'll either have checks in core or extensions will monkeypatch
functions in core disabling incompatible features, enabling new
features, etc.

Things are somewhat tolerable today. But once we introduce alternate
storage backends with varying support for repository features and
vastly different modes of behavior, the current model will quickly
grow unwieldy. For example, the implementation of the "simple store"
required a lot of hacks to deal with stripping and verify because
various parts of core assume things are implemented a certain way.
Partial clone will require new ways of modeling file data retrieval,
because we can no longer assume that all file data is already local.
In this new world, some commands might not make any sense for certain
types of repositories.

What we need is a mechanism to affect the construction of repository
(and eventually peer) instances so the requirements/capabilities
needed for the current operation can be taken into account. "Current
operation" can almost certainly be defined by a command. So it makes
sense for commands to declare their intended actions.

This commit introduces the "intents" concept on the command registrar.
"intents" captures a set of strings that declare actions that are
anticipated to be taken, requirements the repository must possess, etc.
These intents will be passed into hg.repo(), which will pass them into
localrepository, where they can be used to influence the object being
created. Some use cases for this include:

* For read-only intents, constructing a repository object that doesn't
  expose methods that can mutate the repository. Its VFS instances
  don't even allow opening a file with write access.
* For read-only intents, constructing a repository object without
  cache invalidation logic. If the repo never changes during its lifetime,
  nothing ever needs to be invalidated and we don't need to do expensive
  things like verify the changelog's hidden revisions state is accurate
  every time we access repo.changelog.
* We can automatically hide commands from `hg help` when the current
  repository doesn't provide that command. For example, an alternate
  storage backend may not support `hg commit`, so we can hide that
  command or anything else that would perform local commits.

We already kind of had an "intents" mechanism on the registrar in the
form of "cmdtype." However, it was never used. And it was limited to
a single value. We really need something that supports multiple
intents. And because intents may be defined by extensions and at this
point are advisory, I think it is best to define them in a set rather
than as separate arguments/attributes on the command.

Differential Revision:
parent 1859b9a7ddef
......@@ -73,7 +73,7 @@ table = {}
command = registrar.command(table)
readonly = registrar.command.readonly
# common command options
......@@ -1083,7 +1083,8 @@ def branch(ui, repo, label=None, **opts):
_('show only branches that have unmerged heads (DEPRECATED)')),
('c', 'closed', False, _('show normal and closed branches')),
] + formatteropts,
_('[-c]'), cmdtype=readonly)
def branches(ui, repo, active=False, closed=False, **opts):
"""list repository named branches
......@@ -1282,7 +1283,8 @@ def bundle(ui, repo, fname, dest=None, **opts):
('', 'decode', None, _('apply any matching decode filter')),
] + walkopts + formatteropts,
_('[OPTION]... FILE...'),
inferrepo=True, cmdtype=readonly)
def cat(ui, repo, file1, *pats, **opts):
"""output the current or given revision of files
......@@ -1633,7 +1635,8 @@ def _docommit(ui, repo, *pats, **opts):
('l', 'local', None, _('edit repository config')),
('g', 'global', None, _('edit global config'))] + formatteropts,
_('[-u] [NAME]...'),
optionalrepo=True, cmdtype=readonly)
def config(ui, repo, *values, **opts):
"""show combined config settings from all hgrc files
......@@ -1802,7 +1805,8 @@ def debugcomplete(ui, cmd='', **opts):
('c', 'change', '', _('change made by revision'), _('REV'))
] + diffopts + diffopts2 + walkopts + subrepoopts,
_('[OPTION]... ([-c REV] | [-r REV1 [-r REV2]]) [FILE]...'),
inferrepo=True, cmdtype=readonly)
def diff(ui, repo, *pats, **opts):
"""diff repository (or selected files)
......@@ -1895,7 +1899,8 @@ def diff(ui, repo, *pats, **opts):
('', 'switch-parent', None, _('diff against the second parent')),
('r', 'rev', [], _('revisions to export'), _('REV')),
] + diffopts + formatteropts,
_('[OPTION]... [-o OUTFILESPEC] [-r] [REV]...'), cmdtype=readonly)
_('[OPTION]... [-o OUTFILESPEC] [-r] [REV]...'),
def export(ui, repo, *changesets, **opts):
"""dump the header and diffs for one or more changesets
......@@ -1990,7 +1995,8 @@ def export(ui, repo, *changesets, **opts):
[('r', 'rev', '', _('search the repository as it is in REV'), _('REV')),
('0', 'print0', None, _('end filenames with NUL, for use with xargs')),
] + walkopts + formatteropts + subrepoopts,
_('[OPTION]... [FILE]...'), cmdtype=readonly)
_('[OPTION]... [FILE]...'),
def files(ui, repo, *pats, **opts):
"""list tracked files
......@@ -2371,7 +2377,8 @@ def _dograft(ui, repo, *revs, **opts):
('d', 'date', None, _('list the date (short with -q)')),
] + formatteropts + walkopts,
_('[OPTION]... PATTERN [FILE]...'),
inferrepo=True, cmdtype=readonly)
def grep(ui, repo, pattern, *pats, **opts):
"""search revision history for a pattern in specified files
......@@ -2617,7 +2624,8 @@ def grep(ui, repo, pattern, *pats, **opts):
('a', 'active', False, _('show active branchheads only (DEPRECATED)')),
('c', 'closed', False, _('show normal and closed branch heads')),
] + templateopts,
_('[-ct] [-r STARTREV] [REV]...'), cmdtype=readonly)
_('[-ct] [-r STARTREV] [REV]...'),
def heads(ui, repo, *branchrevs, **opts):
"""show branch heads
......@@ -2693,7 +2701,8 @@ def heads(ui, repo, *branchrevs, **opts):
('s', 'system', [], _('show help for specific platform(s)')),
_('[-ecks] [TOPIC]'),
norepo=True, cmdtype=readonly)
def help_(ui, name=None, **opts):
"""show help for a given topic or a help overview
......@@ -2735,7 +2744,8 @@ def help_(ui, name=None, **opts):
('B', 'bookmarks', None, _('show bookmarks')),
] + remoteopts + formatteropts,
_('[-nibtB] [-r REV] [SOURCE]'),
optionalrepo=True, cmdtype=readonly)
def identify(ui, repo, source=None, rev=None,
num=None, id=None, branch=None, tags=None, bookmarks=None, **opts):
"""identify the working directory or specified revision
......@@ -3312,7 +3322,8 @@ def locate(ui, repo, *pats, **opts):
_('do not display revision or any of its ancestors'), _('REV')),
] + logopts + walkopts,
_('[OPTION]... [FILE]'),
inferrepo=True, cmdtype=readonly)
def log(ui, repo, *pats, **opts):
"""show revision history of entire repository or files
......@@ -3480,7 +3491,8 @@ def log(ui, repo, *pats, **opts):
[('r', 'rev', '', _('revision to display'), _('REV')),
('', 'all', False, _("list files from all revisions"))]
+ formatteropts,
_('[-r REV]'), cmdtype=readonly)
_('[-r REV]'),
def manifest(ui, repo, node=None, rev=None, **opts):
"""output the current or given revision of the project manifest
......@@ -3758,7 +3770,7 @@ def parents(ui, repo, file_=None, **opts):
@command('paths', formatteropts, _('[NAME]'), optionalrepo=True,
def paths(ui, repo, search=None, **opts):
"""show aliases for remote repositories
......@@ -4696,7 +4708,7 @@ def rollback(ui, repo, **opts):
return repo.rollback(dryrun=opts.get(r'dry_run'),
@command('root', [], cmdtype=readonly)
@command('root', [], intents={INTENT_READONLY})
def root(ui, repo):
"""print the root (top) of the current working directory
......@@ -4790,7 +4802,8 @@ def serve(ui, repo, **opts):
('', 'change', '', _('list the changed files of a revision'), _('REV')),
] + walkopts + subrepoopts + formatteropts,
_('[OPTION]... [FILE]...'),
inferrepo=True, cmdtype=readonly)
def status(ui, repo, *pats, **opts):
"""show changed files in the working directory
......@@ -4958,7 +4971,8 @@ def status(ui, repo, *pats, **opts):
[('', 'remote', None, _('check for push and pull'))],
'[--remote]', cmdtype=readonly)
def summary(ui, repo, **opts):
"""summarize working directory state
......@@ -5359,7 +5373,7 @@ def tag(ui, repo, name1, *names, **opts):
release(lock, wlock)
@command('tags', formatteropts, '', cmdtype=readonly)
@command('tags', formatteropts, '', intents={INTENT_READONLY})
def tags(ui, repo, **opts):
"""list repository tags
......@@ -5596,7 +5610,8 @@ def verify(ui, repo):
return hg.verify(repo)
@command('version', [] + formatteropts, norepo=True, cmdtype=readonly)
@command('version', [] + formatteropts, norepo=True,
def version_(ui, **opts):
"""output version and copyright information"""
opts = pycompat.byteskwargs(opts)
......@@ -35,7 +35,6 @@ from . import (
ui as uimod,
......@@ -46,8 +45,6 @@ from .utils import (
unrecoverablewrite = registrar.command.unrecoverablewrite
class request(object):
def __init__(self, args, ui=None, repo=None, fin=None, fout=None,
ferr=None, prereposetups=None):
......@@ -562,7 +559,7 @@ class cmdalias(object):
return aliasargs(self.fn, args)
def __getattr__(self, name):
adefaults = {r'norepo': True, r'cmdtype': unrecoverablewrite,
adefaults = {r'norepo': True, r'intents': set(),
r'optionalrepo': False, r'inferrepo': False}
if name not in adefaults:
raise AttributeError(name)
......@@ -138,15 +138,18 @@ class command(_funcregistrarbase):
potential repository locations. See ``findrepo()``. If a repository is
found, it will be used and passed to the decorated function.
There are three constants in the class which tells what type of the command
that is. That information will be helpful at various places. It will be also
be used to decide what level of access the command has on hidden commits.
The constants are:
The `intents` argument defines a set of intended actions or capabilities
the command is taking. These intents can be used to affect the construction
of the repository object passed to the command. For example, commands
declaring that they are read-only could receive a repository that doesn't
have any methods allowing repository mutation. Other intents could be used
to prevent the command from running if the requested intent could not be
`unrecoverablewrite` is for those write commands which can't be recovered
like push.
`recoverablewrite` is for write commands which can be recovered like commit.
`readonly` is for commands which are read only.
The following intents are defined:
The command is read-only
The signature of the decorated function looks like this:
def cmd(ui[, repo] [, <args>] [, <options>])
......@@ -161,29 +164,22 @@ class command(_funcregistrarbase):
descriptions and examples.
unrecoverablewrite = "unrecoverable"
recoverablewrite = "recoverable"
readonly = "readonly"
possiblecmdtypes = {unrecoverablewrite, recoverablewrite, readonly}
def _doregister(self, func, name, options=(), synopsis=None,
norepo=False, optionalrepo=False, inferrepo=False,
if cmdtype not in self.possiblecmdtypes:
raise error.ProgrammingError("unknown cmdtype value '%s' for "
"'%s' command" % (cmdtype, name))
func.norepo = norepo
func.optionalrepo = optionalrepo
func.inferrepo = inferrepo
func.cmdtype = cmdtype
func.intents = intents or set()
if synopsis:
self._table[name] = func, list(options), synopsis
self._table[name] = func, list(options)
return func
INTENT_READONLY = b'readonly'
class revsetpredicate(_funcregistrarbase):
"""Decorator to register revset predicate
......@@ -192,7 +192,7 @@ Test special hash/rev
$ hg log -qr 'null:wdir() & 2147483647'
Commands with undefined cmdtype should not work right now
Commands with undefined intent should not work right now
$ hg phase -r 28ad74
abort: hidden revision '28ad74' was rewritten as: 2443a0e66469!
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment