comparison mercurial/wireprotov2server.py @ 39813:c30faea8d02d

wireprotov2: advertise set of valid values for requestable fields

changesetdata, manifestdata, and filedata all allow the caller to
specify what data fields to request.

Data fields are extensible and may evolve over time. In order to
prevent clients from making requests for fields that are not
available, the client needs to know what fields are available.

This commit teaches the server to declare a set of "valid values"
for wire protocol command arguments. That set of values is exposed
in the command's capabilities descriptor. The changesetdata,
manifestdata, and filedata commands all declare their set of
available "fields."

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

39812:8e7e822e85ec

        'compression': compression,
        'framingmediatypes': [FRAMINGTYPE],
        'pathfilterprefixes': set(narrowspec.VALID_PREFIXES),
    }

    # TODO expose available changesetdata fields.

    for command, entry in COMMANDS.items():
        args = {}

        for arg, meta in entry.args.items():
            args[arg] = {

                b'required': meta['required'],
            }

            if not meta['required']:
                args[arg][b'default'] = meta['default']()

        caps['commands'][command] = {
            'args': args,
            'permissions': [entry.permission],
        }

          Bool indicating whether the argument is required.

       ``example``
          An example value for this argument.

    ``permission`` defines the permission type needed to run this command.
    Can be ``push`` or ``pull``. These roughly map to read-write and read-only,
    respectively. Default is to assume command requires ``push`` permissions
    because otherwise commands not declaring their permissions could modify
    a repository that is supposed to be read-only.

                                         'as required but has a default value' %
                                         (arg, name))

        meta.setdefault('default', lambda: None)
        meta.setdefault('required', False)

    def register(func):
        if name in COMMANDS:
            raise error.ProgrammingError('%s command already registered '
                                         'for version 2' % name)

        },
        'fields': {
            'type': 'set',
            'default': set,
            'example': {b'parents', b'revision'},
        },
    },
    permission='pull')
def changesetdata(repo, proto, noderange, nodes, fields):
    # TODO look for unknown fields and abort when they can't be serviced.

    if noderange is None and nodes is None:
        raise error.WireprotoCommandError(
            'noderange or nodes must be defined')

        },
        'fields': {
            'type': 'set',
            'default': set,
            'example': {b'parents', b'revision'},
        },
        'path': {
            'type': 'bytes',
            'required': True,
            'example': b'foo.txt',

        },
        'fields': {
            'type': 'set',
            'default': set,
            'example': {b'parents', b'revision'},
        },
        'tree': {
            'type': 'bytes',
            'required': True,
            'example': b'',

39813:c30faea8d02d

        'compression': compression,
        'framingmediatypes': [FRAMINGTYPE],
        'pathfilterprefixes': set(narrowspec.VALID_PREFIXES),
    }

    for command, entry in COMMANDS.items():
        args = {}

        for arg, meta in entry.args.items():
            args[arg] = {

                b'required': meta['required'],
            }

            if not meta['required']:
                args[arg][b'default'] = meta['default']()

            if meta['validvalues']:
                args[arg][b'validvalues'] = meta['validvalues']

        caps['commands'][command] = {
            'args': args,
            'permissions': [entry.permission],
        }

          Bool indicating whether the argument is required.

       ``example``
          An example value for this argument.

       ``validvalues``
          Set of recognized values for this argument.

    ``permission`` defines the permission type needed to run this command.
    Can be ``push`` or ``pull``. These roughly map to read-write and read-only,
    respectively. Default is to assume command requires ``push`` permissions
    because otherwise commands not declaring their permissions could modify
    a repository that is supposed to be read-only.

                                         'as required but has a default value' %
                                         (arg, name))

        meta.setdefault('default', lambda: None)
        meta.setdefault('required', False)
        meta.setdefault('validvalues', None)

    def register(func):
        if name in COMMANDS:
            raise error.ProgrammingError('%s command already registered '
                                         'for version 2' % name)

        },
        'fields': {
            'type': 'set',
            'default': set,
            'example': {b'parents', b'revision'},
            'validvalues': {b'bookmarks', b'parents', b'phase', b'revision'},
        },
    },
    permission='pull')
def changesetdata(repo, proto, noderange, nodes, fields):
    # TODO look for unknown fields and abort when they can't be serviced.
    # This could probably be validated by dispatcher using validvalues.

    if noderange is None and nodes is None:
        raise error.WireprotoCommandError(
            'noderange or nodes must be defined')

        },
        'fields': {
            'type': 'set',
            'default': set,
            'example': {b'parents', b'revision'},
            'validvalues': {b'parents', b'revision'},
        },
        'path': {
            'type': 'bytes',
            'required': True,
            'example': b'foo.txt',

        },
        'fields': {
            'type': 'set',
            'default': set,
            'example': {b'parents', b'revision'},
            'validvalues': {b'parents', b'revision'},
        },
        'tree': {
            'type': 'bytes',
            'required': True,
            'example': b'',