sapling/tests/test-dirstate-race.t
Jun Wu 8d4d0a66a2 context: wait for wlock for dirstate fixup if watchman reports fresh instance
Summary:
This is an attempt to solve issues that watchman state in dirstate stays stale
and users have pretty bad experience.

Normally, `hg status` is a "read-only" operation that works in a lock-free way,
and `status` still work if other hg commands are taking a lock. However,
`hg status` does need to update watchman state (clock, need-check file list) to
stay performant.

In case watchman reports "fresh instance" case, watchman also returns all file
paths in the working copy, which means the current `status` has very bad
performance, and the next `status` call can still be bad if the watchman state
in dirstate does not get updated.

This diff adds special handling of "fresh instance", waits for the lock, and
attempts to update the watchman state. It should reduce user frustration about
continuously slow `hg status` commands. In case it failed to update the
watchman state, also print warning messages so the user is aware of the issue.
For example, if there is an ongoing `hg histedit` that waits for the editor.

Reviewed By: wez

Differential Revision: D17468790

fbshipit-source-id: ad06bb1d5d13c6904db328c42a470112c3ee9940
2019-09-19 19:07:50 -07:00

221 lines
5.8 KiB
Perl

Race detector will complain about this test.
$ setconfig fsmonitor.detectrace=0
$ hg init repo
$ cd repo
$ echo a > a
$ hg add a
$ hg commit -m test
Do we ever miss a sub-second change?:
$ for i in 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20; do
> hg co -qC 0
> echo b > a
> hg st
> done
M a
M a
M a
M a
M a
M a
M a
M a
M a
M a
M a
M a
M a
M a
M a
M a
M a
M a
M a
M a
$ echo test > b
$ mkdir dir1
$ echo test > dir1/c
$ echo test > d
$ echo test > e
#if execbit
A directory will typically have the execute bit -- make sure it doesn't get
confused with a file with the exec bit set
$ chmod +x e
#endif
$ hg add b dir1 d e
adding dir1/c
$ hg commit -m test2
$ cat >> $TESTTMP/dirstaterace.py << EOF
> from edenscm.mercurial import (
> context,
> extensions,
> )
> def extsetup():
> extensions.wrapfunction(context.workingctx, '_checklookup', overridechecklookup)
> def overridechecklookup(orig, self, files):
> # make an update that changes the dirstate from underneath
> self._repo.ui.system(r"sh '$TESTTMP/dirstaterace.sh'",
> cwd=self._repo.root)
> return orig(self, files)
> EOF
$ hg debugrebuilddirstate
$ hg debugdirstate
n 0 -1 unset a
n 0 -1 unset b
n 0 -1 unset d
n 0 -1 unset dir1/c
n 0 -1 unset e
XXX Note that this returns M for files that got replaced by directories. This is
definitely a bug, but the fix for that is hard and the next status run is fine
anyway.
$ cat > $TESTTMP/dirstaterace.sh <<EOF
> rm b && rm -r dir1 && rm d && mkdir d && rm e && mkdir e
> EOF
$ hg status --config extensions.dirstaterace=$TESTTMP/dirstaterace.py
M d
M e
! b
! dir1/c
$ hg debugdirstate
n 644 2 * a (glob)
n 0 -1 unset b
n 0 -1 unset d
n 0 -1 unset dir1/c
n 0 -1 unset e
$ hg status
! b
! d
! dir1/c
! e
$ rmdir d e
$ hg update -C -q .
Test that dirstate changes aren't written out at the end of "hg
status", if .hg/dirstate is already changed simultaneously before
acquisition of wlock in workingctx._poststatusfixup().
This avoidance is important to keep consistency of dirstate in race
condition (see issue5584 for detail).
$ hg parents -q
1:* (glob)
$ hg debugrebuilddirstate
$ hg debugdirstate
n 0 -1 unset a
n 0 -1 unset b
n 0 -1 unset d
n 0 -1 unset dir1/c
n 0 -1 unset e
$ cat > $TESTTMP/dirstaterace.sh <<EOF
> # This script assumes timetable of typical issue5584 case below:
> #
> # 1. "hg status" loads .hg/dirstate
> # 2. "hg status" confirms clean-ness of FILE
> # 3. "hg update -C 0" updates the working directory simultaneously
> # (FILE is removed, and FILE is dropped from .hg/dirstate)
> # 4. "hg status" acquires wlock
> # (.hg/dirstate is re-loaded = no FILE entry in dirstate)
> # 5. "hg status" marks FILE in dirstate as clean
> # (FILE entry is added to in-memory dirstate)
> # 6. "hg status" writes dirstate changes into .hg/dirstate
> # (FILE entry is written into .hg/dirstate)
> #
> # To reproduce similar situation easily and certainly, #2 and #3
> # are swapped. "hg cat" below ensures #2 on "hg status" side.
>
> hg update -q -C 0
> hg cat -r 1 b > b
> EOF
"hg status" below should excludes "e", of which exec flag is set, for
portability of test scenario, because unsure but missing "e" is
treated differently in _checklookup() according to runtime platform.
- "missing(!)" on POSIX, "pctx[f].cmp(self[f])" raises ENOENT
- "modified(M)" on Windows, "self.flags(f) != pctx.flags(f)" is True
#if fsmonitor
$ hg status --config extensions.dirstaterace=$TESTTMP/dirstaterace.py --debug -X path:e
poststatusfixup decides to wait for wlock since watchman reported fresh instance
warning: failed to update watchman state because dirstate has been changed by other processes
(status will still be slow next time; try to complete or abort other source control operations and then run 'hg status' again)
skip updating dirstate: identity mismatch
M a
! d
! dir1/c
#else
$ hg status --config extensions.dirstaterace=$TESTTMP/dirstaterace.py --debug -X path:e
skip updating dirstate: identity mismatch
M a
! d
! dir1/c
#endif
$ hg parents -q
0:* (glob)
$ hg files
a
$ hg debugdirstate
n * * * a (glob)
$ rm b
Set up a rebase situation for issue5581.
$ echo c2 > a
$ echo c2 > b
$ hg add b
$ hg commit -m c2
$ echo c3 >> a
$ hg commit -m c3
$ hg update 2
1 files updated, 0 files merged, 0 files removed, 0 files unresolved
$ echo c4 >> a
$ echo c4 >> b
$ hg commit -m c4
Configure a merge tool that runs status in the middle of the rebase. The goal of
the status call is to trigger a potential bug if fsmonitor's state is written
even though the wlock is held by another process. The output of 'hg status' in
the merge tool goes to /dev/null because we're more interested in the results of
'hg status' run after the rebase.
$ cat >> $TESTTMP/mergetool-race.sh << EOF
> echo "custom merge tool"
> printf "c2\nc3\nc4\n" > \$1
> hg --cwd "$TESTTMP/repo" status --pager=off > /dev/null
> echo "custom merge tool end"
> EOF
$ cat >> $HGRCPATH << EOF
> [extensions]
> rebase =
> [merge-tools]
> test.executable=sh
> test.args=$TESTTMP/mergetool-race.sh \$output
> EOF
$ hg rebase -s . -d 3 --tool test
rebasing 4:b08445fd6b2a "c4" (tip)
merging a
custom merge tool
custom merge tool end
This hg status should be empty, whether or not fsmonitor is enabled (issue5581).
$ hg status