mercurial/revlogutils/concurrency_checker.py
author Matt Harbison <matt_harbison@yahoo.com>
Fri, 04 Oct 2024 01:40:35 -0400
changeset 51952 f4c038081561
parent 51864 1c5810ce737e
permissions -rw-r--r--
run-tests: bump the default timeout on Windows to 4x the normal value There are a ridiculous number of tests that timeout on Windows with the 360 sec default (~60). And because of the bug where timed out tests still run to completion before the results are thrown away[1], the timeout does nothing but waste time, so there's no reason to try to find a lower value that still works. For reference on my system: # Ran 909 tests, 116 skipped, 119 failed. python hash seed: 2052473208 real 151m44.322s user 0m0.077s sys 0m0.046s [1] I thought that I wrote a bug for this, but search isn't finding it.

from __future__ import annotations

from ..i18n import _
from .. import error


def get_checker(ui, revlog_name=b'changelog'):
    """Get a function that checks file handle position is as expected.

    This is used to ensure that files haven't been modified outside of our
    knowledge (such as on a networked filesystem, if `hg debuglocks` was used,
    or writes to .hg that ignored locks happened).

    Due to revlogs supporting a concept of buffered, delayed, or diverted
    writes, we're allowing the files to be shorter than expected (the data may
    not have been written yet), but they can't be longer.

    Please note that this check is not perfect; it can't detect all cases (there
    may be false-negatives/false-OKs), but it should never claim there's an
    issue when there isn't (false-positives/false-failures).
    """

    vpos = ui.config(b'debug', b'revlog.verifyposition.' + revlog_name)
    # Avoid any `fh.tell` cost if this isn't enabled.
    if not vpos or vpos not in [b'log', b'warn', b'fail']:
        return None

    def _checker(fh, fn, expected):
        if fh.tell() <= expected:
            return

        msg = _(b'%s: file cursor at position %d, expected %d')
        # Always log if we're going to warn or fail.
        ui.log(b'debug', msg + b'\n', fn, fh.tell(), expected)
        if vpos == b'warn':
            ui.warn((msg + b'\n') % (fn, fh.tell(), expected))
        elif vpos == b'fail':
            raise error.RevlogError(msg % (fn, fh.tell(), expected))

    return _checker