tests/sshprotoext.py

bundle: emit full snapshot as is, without doing a redelta

With the new `forced` delta-reused policy, it become important to be able to
send full snapshot where full snapshot are needed. Otherwise, the fallback delta
will simply be used on the client side… creating monstrous delta chain, since
revision that are meant as a reset of delta-chain chain becoming too complex are
simply adding a new full delta-tree on the leaf of another one.

In the `non-forced` cases, client process full snapshot from the bundle
differently from deltas, so client will still try to convert the full snapshot
into a delta if possible. So this will no lead to pathological storage
explosion.

I have considered making this configurable, but the impact seems limited enough
that it does not seems to be worth it. Especially with the current
sparse-revlog format that use "delta-tree" with multiple level snapshots, full
snapshot are much less frequent and not that different from other intermediate
snapshot that we are already sending over the wire anyway.

CPU wise, this will help the bundling side a little as it will not need to
reconstruct revisions and compute deltas. The unbundling side might save a tiny
amount of CPU as it won't need to reconstruct the delta-base to reconstruct the
revision full text. This only slightly visible in some of the benchmarks. And
have no real impact on most of them.

### data-env-vars.name      = pypy-2018-08-01-zstd-sparse-revlog
  # benchmark.name          = perf-bundle
  # benchmark.variants.revs = last-40000
before:          11.467186 seconds
just-emit-full:  11.190576 seconds   (-2.41%)
with-pull-force: 11.041091 seconds   (-3.72%)
  # benchmark.name          = perf-unbundle
  # benchmark.variants.revs = last-40000
before:     16.744862
just-emit-full:: 16.561036 seconds   (-1.10%)
with-pull-force: 16.389344 seconds   (-2.12%)
  # benchmark.name          = pull
  # benchmark.variants.revs = last-40000
before:     26.870569
just-emit-full:  26.391188 seconds   (-1.78%)
with-pull-force: 25.633184 seconds   (-4.60%)


Space wise (so network-wise) the impact is fairly small. When taking compression into
account.

Below are tests the size of `hg bundle --all` for a handful of benchmark repositories
(with bzip, zstd compression and without it)

This show a small increase in the bundle size, but nothing really significant
except maybe for mozilla-try (+12%) that nobody really pulls large chunk of anyway.
Mozilla-try is also the repository that benefit the most for not having to
recompute deltas client size.

### mercurial:
bzip-before:     26 406 342 bytes
bzip-after:      26 691 543 bytes  +1.08%

zstd-before:     27 918 645 bytes
zstd-after:      28 075 896 bytes  +0.56%

none-before:     98 675 601 bytes
none-after:     100 411 237 bytes  +1.76%


### pypy
bzip-before:    201 295 752 bytes
bzip-after:     209 780 282 bytes  +4.21%

zstd-before:    202 974 795 bytes
zstd-after:     205 165 780 bytes  +1.08%

none-before:    871 070 261 bytes
none-after:     993 595 057 bytes +14.07%


### netbeans
bzip-before:    601 314 330 bytes
bzip-after:     614 246 241 bytes  +2.15%

zstd-before:    604 745 136 bytes
zstd-after:     615 497 705 bytes  +1.78%

none-before:  3 338 238 571 bytes
none-after:   3 439 422 535 bytes  +3.03%


### mozilla-central
bzip-before:  1 493 006 921 bytes
bzip-after:   1 549 650 570 bytes  +3.79%

zstd-before:  1 481 910 102 bytes
zstd-after:   1 513 052 415 bytes  +2.10%

none-before:  6 535 929 910 bytes
none-after:   7 010 191 342 bytes  +7.26%


### mozilla-try
bzip-before:  6 583 425 999 bytes
bzip-after:   7 423 536 928 bytes +12.76%

zstd-before:  6 021 009 212 bytes
zstd-after:   6 674 922 420 bytes +10.86%

none-before: 22 954 739 558 bytes
none-after:  26 013 854 771 bytes +13.32%

# sshprotoext.py - Extension to test behavior of SSH protocol
#
# Copyright 2018 Gregory Szorc <[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.

# This extension replaces the SSH server started via `hg serve --stdio`.
# The server behaves differently depending on environment variables.


from mercurial import (
    error,
    extensions,
    registrar,
    sshpeer,
    wireprotoserver,
    wireprotov1server,
)

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

configitem(b'sshpeer', b'mode', default=None)
configitem(b'sshpeer', b'handshake-mode', default=None)


class bannerserver(wireprotoserver.sshserver):
    """Server that sends a banner to stdout."""

    def serve_forever(self):
        for i in range(10):
            self._fout.write(b'banner: line %d\n' % i)

        super(bannerserver, self).serve_forever()


class prehelloserver(wireprotoserver.sshserver):
    """Tests behavior when connecting to <0.9.1 servers.

    The ``hello`` wire protocol command was introduced in Mercurial
    0.9.1. Modern clients send the ``hello`` command when connecting
    to SSH servers. This mock server tests behavior of the handshake
    when ``hello`` is not supported.
    """

    def serve_forever(self):
        l = self._fin.readline()
        assert l == b'hello\n'
        # Respond to unknown commands with an empty reply.
        wireprotoserver._sshv1respondbytes(self._fout, b'')
        l = self._fin.readline()
        assert l == b'between\n'
        proto = wireprotoserver.sshv1protocolhandler(
            self._ui, self._fin, self._fout
        )
        rsp = wireprotov1server.dispatch(self._repo, proto, b'between')
        wireprotoserver._sshv1respondbytes(self._fout, rsp.data)

        super(prehelloserver, self).serve_forever()


def performhandshake(orig, ui, stdin, stdout, stderr):
    """Wrapped version of sshpeer._performhandshake to send extra commands."""
    mode = ui.config(b'sshpeer', b'handshake-mode')
    if mode == b'pre-no-args':
        ui.debug(b'sending no-args command\n')
        stdin.write(b'no-args\n')
        stdin.flush()
        return orig(ui, stdin, stdout, stderr)
    elif mode == b'pre-multiple-no-args':
        ui.debug(b'sending unknown1 command\n')
        stdin.write(b'unknown1\n')
        ui.debug(b'sending unknown2 command\n')
        stdin.write(b'unknown2\n')
        ui.debug(b'sending unknown3 command\n')
        stdin.write(b'unknown3\n')
        stdin.flush()
        return orig(ui, stdin, stdout, stderr)
    else:
        raise error.ProgrammingError(b'unknown HANDSHAKECOMMANDMODE: %s' % mode)


def extsetup(ui):
    # It's easier for tests to define the server behavior via environment
    # variables than config options. This is because `hg serve --stdio`
    # has to be invoked with a certain form for security reasons and
    # `dummyssh` can't just add `--config` flags to the command line.
    servermode = ui.environ.get(b'SSHSERVERMODE')

    if servermode == b'banner':
        wireprotoserver.sshserver = bannerserver
    elif servermode == b'no-hello':
        wireprotoserver.sshserver = prehelloserver
    elif servermode:
        raise error.ProgrammingError(b'unknown server mode: %s' % servermode)

    peermode = ui.config(b'sshpeer', b'mode')

    if peermode == b'extra-handshake-commands':
        extensions.wrapfunction(sshpeer, '_performhandshake', performhandshake)
    elif peermode:
        raise error.ProgrammingError(b'unknown peer mode: %s' % peermode)