doc/docchecker

lfs: fix the stall and corruption issue when concurrently uploading blobs

We've avoided the issue up to this point by gating worker usage with an
experimental config.  See 10e62d5efa73, and the thread linked there for some of
the initial diagnosis, but essentially some data was being read from the blob
before an error occurred and `keepalive` retried, but didn't rewind the file
pointer.  So the leading data was lost from the blob on the server, and the
connection stalled, trying to send more data than available.

In trying to recreate this, I was unable to do so uploading from Windows to
CentOS 7.  But it reproduced every time going from CentOS 7 to another CentOS 7
over https.

I found recent fixes in the FaceBook repo to address this[1][2].  The commit
message for the first is:

    The KeepAlive HTTP implementation is bugged in it's retry logic, it supports
    reading from a file pointer, but doesn't support rewinding of the seek cursor
    when it performs a retry. So it can happen that an upload fails for whatever
    reason and will then 'hang' on the retry event.

    The sequence of events that get triggered are:
     - Upload file A, goes OK. Keep-Alive caches connection.
     - Upload file B, fails due to (for example) failing Keep-Alive, but LFS file
       pointer has been consumed for the upload and fd has been closed.
     - Retry for file B starts, sets the Content-Length properly to the expected
       file size, but since file pointer has been consumed no data will be uploaded,
       causing the server to wait for the uploaded data until either client or
       server reaches a timeout, making it seem as our mercurial process hangs.

    This is just a stop-gap measure to prevent this behavior from blocking Mercurial
    (LFS has retry logic). A proper solutions need to be build on top of this
    stop-gap measure: for upload from file pointers, we should support fseek() on
    the interface. Since we expect to consume the whole file always anyways, this
    should be safe. This way we can seek back to the beginning on a retry.

I ported those two patches, and it works.  But I see that `url._sendfile()` does
a rewind on `httpsendfile` objects[3], so maybe it's better to keep this all in
one place and avoid a second seek.  We may still want the first FaceBook patch
as extra protection for this problem in general.  The other two uses of
`httpsendfile` are in the wire protocol to upload bundles, and to upload
largefiles.  Neither of these appear to use a worker, and I'm not sure why
workers seem to trigger this, or if this could have happened without a worker.

Since `httpsendfile` already has a `close()` method, that is dropped.  That
class also explicitly says there's no `__len__` attribute, so that is removed
too.  The override for `read()` is necessary to avoid the progressbar usage per
file.

[1] https://github.com/facebookexperimental/eden/commit/c350d6536d90c044c837abdd3675185644481469
[2] https://github.com/facebookexperimental/eden/commit/77f0d3fd0415e81b63e317e457af9c55c46103ee
[3] https://www.mercurial-scm.org/repo/hg/file/5.2.2/mercurial/url.py#l176

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

#!/usr/bin/env python
#
# docchecker - look for problematic markup
#
# Copyright 2016 timeless <[e-mail]> and others
#
# This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version.

from __future__ import absolute_import, print_function

import os
import re
import sys

try:
    import msvcrt

    msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
    msvcrt.setmode(sys.stderr.fileno(), os.O_BINARY)
except ImportError:
    pass

stdout = getattr(sys.stdout, 'buffer', sys.stdout)

leadingline = re.compile(br'(^\s*)(\S.*)$')

checks = [
    (
        br""":hg:`[^`]*'[^`]*`""",
        b"""warning: please avoid nesting ' in :hg:`...`""",
    ),
    (br'\w:hg:`', b'warning: please have a space before :hg:'),
    (
        br"""(?:[^a-z][^'.])hg ([^,;"`]*'(?!hg)){2}""",
        b'''warning: please use " instead of ' for hg ... "..."''',
    ),
]


def check(line):
    messages = []
    for match, msg in checks:
        if re.search(match, line):
            messages.append(msg)
    if messages:
        stdout.write(b'%s\n' % line)
        for msg in messages:
            stdout.write(b'%s\n' % msg)


def work(file):
    (llead, lline) = (b'', b'')

    for line in file:
        # this section unwraps lines
        match = leadingline.match(line)
        if not match:
            check(lline)
            (llead, lline) = (b'', b'')
            continue

        lead, line = match.group(1), match.group(2)
        if lead == llead:
            if lline != b'':
                lline += b' ' + line
            else:
                lline = line
        else:
            check(lline)
            (llead, lline) = (lead, line)
    check(lline)


def main():
    for f in sys.argv[1:]:
        try:
            with open(f, 'rb') as file:
                work(file)
        except BaseException as e:
            sys.stdout.write(r"failed to process %s: %s\n" % (f, e))


main()