annotate hgext/bookflow.py @ 47866:4162f6b40f2c stable

windows: degrade to py2 behavior when reading a non-symlink as a symlink

While waiting for the push to hg-committed in WSL to complete, I ran a
`phabimport` from Windows and got this traceback:

    $ hg phabimport 11313
    ** Unknown exception encountered with possibly-broken third-party extension "mercurial_keyring" (version N/A)
    ** which supports versions unknown of Mercurial.
    ** Please disable "mercurial_keyring" and try your action again.
    ** If that fixes the bug please report it to https://foss.heptapod.net/mercurial/mercurial_keyring/issues
    ** Python 3.9.5 (default, May  6 2021, 17:29:31) [MSC v.1928 64 bit (AMD64)]
    ** Mercurial Distributed SCM (version 5.9rc1+hg32.0e2f5733563d)
    ** Extensions loaded: absorb, blackbox, evolve 10.3.3, extdiff, fastannotate, fix, mercurial_keyring, mq, phabblocker 20210126, phabricator, rebase, show, strip, topic 0.22.3
    Traceback (most recent call last):
      File "mercurial.lock", line 279, in _trylock
      File "mercurial.vfs", line 202, in makelock
      File "mercurial.util", line 2147, in makelock
    FileExistsError: [WinError 183] Cannot create a file when that file already exists: b'hp-omen:78348' -> b'C:\\Users\\Matt\\hg/.hg/store/lock'

    During handling of the above exception, another exception occurred:

    Traceback (most recent call last):
      File "<string>", line 24, in <module>
      File "mercurial.dispatch", line 144, in run
      File "mercurial.dispatch", line 250, in dispatch
      File "mercurial.dispatch", line 294, in _rundispatch
      File "mercurial.dispatch", line 470, in _runcatch
      File "mercurial.dispatch", line 480, in _callcatch
      File "mercurial.scmutil", line 153, in callcatch
      File "mercurial.dispatch", line 460, in _runcatchfunc
      File "mercurial.dispatch", line 1273, in _dispatch
      File "mercurial.dispatch", line 918, in runcommand
      File "mercurial.dispatch", line 1285, in _runcommand
      File "mercurial.dispatch", line 1271, in <lambda>
      File "mercurial.util", line 1886, in check
      File "mercurial.util", line 1886, in check
      File "hgext.mq", line 4239, in mqcommand
      File "mercurial.util", line 1886, in check
      File "mercurial.util", line 1886, in check
      File "hgext.phabricator", line 314, in inner
      File "hgext.phabricator", line 2222, in phabimport
      File "hgext.phabricator", line 2123, in readpatch
      File "hgext.phabricator", line 2199, in _write
      File "mercurial.localrepo", line 2956, in lock
      File "mercurial.localrepo", line 2918, in _lock
      File "mercurial.lock", line 152, in trylock
      File "mercurial.lock", line 283, in _trylock
      File "mercurial.lock", line 314, in _readlock
      File "mercurial.vfs", line 221, in readlock
      File "mercurial.util", line 2163, in readlock
      File "mercurial.windows", line 619, in readlink
    ValueError: not a symbolic link

Both exceptions look accurate (the file exists, and the Windows side can't read
WSL side symlinks).  I didn't try to reproduce this entirely within the Windows
side, but we can do better than a cryptic stacktrace.  With this change, the
same scenario results in this abort:

    abort: C:\Users\Matt\hg/.hg/store/lock: The file cannot be accessed by the system

When both the `push` and `phabimport` are done on the Windows side, it prints a
message about waiting for the lock, and successfully applies the patch after the
push completes.

I'm not sure if there's enough info to be able to convert the abort into the
wait scenario.  As it stands now, we don't support symlinks on Windows, which
requires either a UAC Administrator level process or an opt-in in developer
mode, and there are several places where the new symlink on Windows support in
py3 was explicitly disabled in order to get tests to pass quicker.

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

"""implements bookmark-based branching (EXPERIMENTAL)

 - Disables creation of new branches (config: enable_branches=False).
 - Requires an active bookmark on commit (config: require_bookmark=True).
 - Doesn't move the active bookmark on update, only on commit.
 - Requires '--rev' for moving an existing bookmark.
 - Protects special bookmarks (config: protect=@).

 flow related commands

    :hg book NAME: create a new bookmark
    :hg book NAME -r REV: move bookmark to revision (fast-forward)
    :hg up|co NAME: switch to bookmark
    :hg push -B .: push active bookmark
"""
from __future__ import absolute_import

from mercurial.i18n import _
from mercurial import (
    bookmarks,
    commands,
    error,
    extensions,
    registrar,
)

MY_NAME = b'bookflow'

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

configitem(MY_NAME, b'protect', [b'@'])
configitem(MY_NAME, b'require-bookmark', True)
configitem(MY_NAME, b'enable-branches', False)

cmdtable = {}
command = registrar.command(cmdtable)


def commit_hook(ui, repo, **kwargs):
    active = repo._bookmarks.active
    if active:
        if active in ui.configlist(MY_NAME, b'protect'):
            raise error.Abort(
                _(b'cannot commit, bookmark %s is protected') % active
            )
        if not cwd_at_bookmark(repo, active):
            raise error.Abort(
                _(
                    b'cannot commit, working directory out of sync with active bookmark'
                ),
                hint=_(b"run 'hg up %s'") % active,
            )
    elif ui.configbool(MY_NAME, b'require-bookmark', True):
        raise error.Abort(_(b'cannot commit without an active bookmark'))
    return 0


def bookmarks_update(orig, repo, parents, node):
    if len(parents) == 2:
        # called during commit
        return orig(repo, parents, node)
    else:
        # called during update
        return False


def bookmarks_addbookmarks(
    orig, repo, tr, names, rev=None, force=False, inactive=False
):
    if not rev:
        marks = repo._bookmarks
        for name in names:
            if name in marks:
                raise error.Abort(
                    _(
                        b"bookmark %s already exists, to move use the --rev option"
                    )
                    % name
                )
    return orig(repo, tr, names, rev, force, inactive)


def commands_commit(orig, ui, repo, *args, **opts):
    commit_hook(ui, repo)
    return orig(ui, repo, *args, **opts)


def commands_pull(orig, ui, repo, *args, **opts):
    rc = orig(ui, repo, *args, **opts)
    active = repo._bookmarks.active
    if active and not cwd_at_bookmark(repo, active):
        ui.warn(
            _(
                b"working directory out of sync with active bookmark, run "
                b"'hg up %s'"
            )
            % active
        )
    return rc


def commands_branch(orig, ui, repo, label=None, **opts):
    if label and not opts.get('clean') and not opts.get('rev'):
        raise error.Abort(
            _(
                b"creating named branches is disabled and you should use bookmarks"
            ),
            hint=b"see 'hg help bookflow'",
        )
    return orig(ui, repo, label, **opts)


def cwd_at_bookmark(repo, mark):
    mark_id = repo._bookmarks[mark]
    cur_id = repo.lookup(b'.')
    return cur_id == mark_id


def uisetup(ui):
    extensions.wrapfunction(bookmarks, b'update', bookmarks_update)
    extensions.wrapfunction(bookmarks, b'addbookmarks', bookmarks_addbookmarks)
    extensions.wrapcommand(commands.table, b'commit', commands_commit)
    extensions.wrapcommand(commands.table, b'pull', commands_pull)
    if not ui.configbool(MY_NAME, b'enable-branches'):
        extensions.wrapcommand(commands.table, b'branch', commands_branch)