view tests/test-notify-changegroup.t @ 25757:4d1382fd96ff

context: write dirstate out explicitly at the end of markcommitted

To detect change of a file without redundant comparison of file
content, dirstate recognizes a file as certainly clean, if:

  (1) it is already known as "normal",
  (2) dirstate entry for it has valid (= not "-1") timestamp, and
  (3) mode, size and timestamp of it on the filesystem are as same as
      ones expected in dirstate

This works as expected in many cases, but doesn't in the corner case
that changing a file keeps mode, size and timestamp of it on the
filesystem.

The timetable below shows steps in one of typical such situations:

  ---- ----------------------------------- ----------------
                                           timestamp of "f"
                                           ----------------
                                           dirstate   file-
  time          action                     mem  file  system
  ---- ----------------------------------- ---- ----- -----
   *                                             ***    ***
       - 'hg transplant REV1 REV2 ...'
         - transplanting REV1
           ....
   N
           - change "f", but keep size                   N
             (via 'patch.patch()')
           - 'dirstate.normal("f")'          N   ***
             (via 'repo.commit()')

         - transplanting REV2
           - change "f", but keep size                   N
             (via 'patch.patch()')
           - aborted while patching
  N+1
         - release wlock
           - 'dirstate.write()'              N    N      N

       - 'hg status' shows "r1" as "clean"   N    N      N
  ---- ----------------------------------- ---- ----- -----

The most important point is that 'dirstate.write()' is executed at N+1
or later. This causes writing dirstate timestamp N of "f" out
successfully. If it is executed at N, 'parsers.pack_dirstate()'
replaces timestamp N with "-1" before actual writing dirstate out.

This issue can occur when 'hg transplant' satisfies conditions below:

  - multiple revisions to be transplanted change the same file
  - those revisions don't change mode and size of the file, and
  - the 2nd or later revision of them fails after changing the file

The root cause of this issue is that files are changed without
flushing in-memory dirstate changes via 'repo.commit()' (even though
omitting 'dirstate.normallookup()' on files changed by 'patch.patch()'
for efficiency also causes this issue).

To detect changes of files correctly, this patch writes in-memory
dirstate changes out explicitly after marking files as clean in
'committablectx.markcommitted()', which is invoked via
'repo.commit()'.

After this change, timetable is changed as below:

  ---- ----------------------------------- ----------------
                                           timestamp of "f"
                                           ----------------
                                           dirstate   file-
  time          action                     mem  file  system
  ---- ----------------------------------- ---- ----- -----
   *                                             ***    ***
       - 'hg transplant REV1 REV2 ...'
         - transplanting REV1
           ....
   N
           - change "f", but keep size                   N
             (via 'patch.patch()')
           - 'dirstate.normal("f")'          N    ***
             (via 'repo.commit()')
       ----------------------------------- ---- ----- -----
           - 'dirsttate.write()'            -1    -1
       ----------------------------------- ---- ----- -----
         - transplanting REV2
           - change "f", but keep size                   N
             (via 'patch.patch()')
           - aborted while patching
  N+1
         - release wlock
           - 'dirstate.write()'              -1   -1     N

       - 'hg status' shows "r1" as "clean"   -1   -1     N
  ---- ----------------------------------- ---- ----- -----

To reproduce this issue in tests certainly, this patch emulates some
timing critical actions as below:

  - change "f" at N

    'patch.patch()' with 'fakepatchtime.py' explicitly changes mtime
    of patched files to "2000-01-01 00:00" (= N).

  - 'dirstate.write()' via 'repo.commit()' at N

    'fakedirstatewritetime.py' forces 'pack_dirstate()' to use
    "2000-01-01 00:00" as "now", only if 'pack_dirstate()' is invoked
    via 'committablectx.markcommitted()'.

  - 'dirstate.write()' via releasing wlock at N+1 (or "not at N")

    'pack_dirstate()' via releasing wlock uses actual timestamp at
    runtime as "now", and it should be different from the "2000-01-01
    00:00" of "f".

BTW, this patch doesn't test cases below, even though 'patch.patch()'
is used similarly in these cases:

  1. failure of 'hg import' or 'hg qpush'

  2. success of 'hg import', 'hg qpush' or 'hg transplant'

Case (1) above doesn't cause this kind of issue, because:

  - if patching is aborted by conflicts, changed files are committed

    changed files are marked as CLEAN, even though they are partially
    patched.

  - otherwise, dirstate are fully restored by 'dirstateguard'

    For example in timetable above, timestamp of "f" in .hg/dirstate
    is restored to -1 (or less than N), and subsequent 'hg status' can
    detect changes correctly.

Case (2) always causes 'repo.status()' invocation via 'repo.commit()'
just after changing files inside same wlock scope.

  ---- ----------------------------------- ----------------
                                           timestamp of "f"
                                           ----------------
                                           dirstate   file-
  time          action                     mem  file  system
  ---- ----------------------------------- ---- ----- -----
  N                                              ***   ***
       - make file "f" clean                            N

       - execute 'hg foobar'
         ....
         - 'dirstate.normal("f")'           N    ***
           (e.g. via dirty check
            or previous 'repo.commit()')

         - change "f", but keep size                    N
         - 'repo.status()' (*1)
           (via 'repo.commit()')
  ---- ----------------------------------- ---- ----- -----

At a glance, 'repo.status()' at (*1) seems to cause similar issue (=
"changed files are treated as clean"), but actually doesn't.

'dirstate._lastnormaltime' should be N at (*1) above, because
'dirstate.normal()' via dirty check is finished at N.

Therefore, "f" changed at N (= 'dirstate._lastnormaltime') is forcibly
treated as "unsure" at (*1), and changes are detected as expected (see
'dirstate.status()' for detail).

If 'hg import' is executed with '--no-commit', 'repo.status()' isn't
invoked just after changing files inside same wlock scope.

But preceding 'dirstate.normal()' is invoked inside another wlock
scope via 'cmdutil.bailifchanged()', and in-memory changes should be
flushed at the end of that scope.

Therefore, timestamp N of clean "f" should be replaced by -1, if
'dirstate.write()' is invoked at N. It means that condition of this
issue isn't satisfied.

  $ cat <<EOF >> $HGRCPATH
  > [extensions]
  > notify=
  > 
  > [hooks]
  > changegroup.notify = python:hgext.notify.hook
  > 
  > [notify]
  > sources = push
  > diffstat = False
  > maxsubject = 10
  > 
  > [usersubs]
  > foo@bar = *
  > 
  > [reposubs]
  > * = baz
  > EOF
  $ hg init a

clone

  $ hg --traceback clone a b
  updating to branch default
  0 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ echo a > b/a

commit

  $ hg --traceback --cwd b commit -Ama
  adding a
  $ echo a >> b/a

commit

  $ hg --traceback --cwd b commit -Amb

push

  $ hg --traceback --cwd b push ../a 2>&1 |
  >     $PYTHON -c 'import sys,re; print re.sub("\n\t", " ", sys.stdin.read()),'
  pushing to ../a
  searching for changes
  adding changesets
  adding manifests
  adding file changes
  added 2 changesets with 2 changes to 1 files
  Content-Type: text/plain; charset="us-ascii"
  MIME-Version: 1.0
  Content-Transfer-Encoding: 7bit
  Date: * (glob)
  Subject: * (glob)
  From: test
  X-Hg-Notification: changeset cb9a9f314b8b
  Message-Id: <*> (glob)
  To: baz, foo@bar
  
  changeset cb9a9f314b8b in $TESTTMP/a (glob)
  details: $TESTTMP/a?cmd=changeset;node=cb9a9f314b8b
  summary: a
  
  changeset ba677d0156c1 in $TESTTMP/a (glob)
  details: $TESTTMP/a?cmd=changeset;node=ba677d0156c1
  summary: b
  
  diffs (6 lines):
  
  diff -r 000000000000 -r ba677d0156c1 a
  --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
  +++ b/a	Thu Jan 01 00:00:00 1970 +0000
  @@ -0,0 +1,2 @@
  +a
  +a
  $ hg --cwd a rollback
  repository tip rolled back to revision -1 (undo push)

unbundle with unrelated source

  $ hg --cwd b bundle ../test.hg ../a
  searching for changes
  2 changesets found
  $ hg --cwd a unbundle ../test.hg
  adding changesets
  adding manifests
  adding file changes
  added 2 changesets with 2 changes to 1 files
  (run 'hg update' to get a working copy)
  $ hg --cwd a rollback
  repository tip rolled back to revision -1 (undo unbundle)

unbundle with correct source

  $ hg --config notify.sources=unbundle --cwd a unbundle ../test.hg 2>&1 |
  >     $PYTHON -c 'import sys,re; print re.sub("\n\t", " ", sys.stdin.read()),'
  adding changesets
  adding manifests
  adding file changes
  added 2 changesets with 2 changes to 1 files
  Content-Type: text/plain; charset="us-ascii"
  MIME-Version: 1.0
  Content-Transfer-Encoding: 7bit
  Date: * (glob)
  Subject: * (glob)
  From: test
  X-Hg-Notification: changeset cb9a9f314b8b
  Message-Id: <*> (glob)
  To: baz, foo@bar
  
  changeset cb9a9f314b8b in $TESTTMP/a (glob)
  details: $TESTTMP/a?cmd=changeset;node=cb9a9f314b8b
  summary: a
  
  changeset ba677d0156c1 in $TESTTMP/a (glob)
  details: $TESTTMP/a?cmd=changeset;node=ba677d0156c1
  summary: b
  
  diffs (6 lines):
  
  diff -r 000000000000 -r ba677d0156c1 a
  --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
  +++ b/a	Thu Jan 01 00:00:00 1970 +0000
  @@ -0,0 +1,2 @@
  +a
  +a
  (run 'hg update' to get a working copy)

Check that using the first committer as the author of a changeset works:
Check that the config option works.
Check that the first committer is indeed used for "From:".
Check that the merge user is NOT used for "From:"

Create new file

  $ echo a > b/b
  $ echo b >> b/b
  $ echo c >> b/b
  $ hg --traceback --cwd b commit -Amnewfile -u committer_1
  adding b

commit as one user

  $ echo x > b/b
  $ echo b >> b/b
  $ echo c >> b/b
  $ hg --traceback --cwd b commit -Amx -u committer_2

commit as other user, change file so we can do an (automatic) merge

  $ hg --cwd b up 2
  1 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ echo a > b/b
  $ echo b >> b/b
  $ echo y >> b/b
  $ hg --traceback --cwd b commit -Amy -u committer_3
  created new head

merge as a different user

  $ hg --cwd b merge --config notify.fromauthor=True
  merging b
  0 files updated, 1 files merged, 0 files removed, 0 files unresolved
  (branch merge, don't forget to commit)

  $ hg --traceback --cwd b commit -Am "merged"

push

  $ hg --traceback --cwd b --config notify.fromauthor=True push ../a 2>&1 |
  >     $PYTHON -c 'import sys,re; print re.sub("\n\t", " ", sys.stdin.read()),'
  pushing to ../a
  searching for changes
  adding changesets
  adding manifests
  adding file changes
  added 4 changesets with 4 changes to 1 files
  Content-Type: text/plain; charset="us-ascii"
  MIME-Version: 1.0
  Content-Transfer-Encoding: 7bit
  Date: * (glob)
  Subject: * (glob)
  From: committer_1
  X-Hg-Notification: changeset 84e487dddc58
  Message-Id: <*> (glob)
  To: baz, foo@bar
  
  changeset 84e487dddc58 in $TESTTMP/a (glob)
  details: $TESTTMP/a?cmd=changeset;node=84e487dddc58
  summary: newfile
  
  changeset b29c7a2b6b0c in $TESTTMP/a (glob)
  details: $TESTTMP/a?cmd=changeset;node=b29c7a2b6b0c
  summary: x
  
  changeset 0957c7d64886 in $TESTTMP/a (glob)
  details: $TESTTMP/a?cmd=changeset;node=0957c7d64886
  summary: y
  
  changeset 485b4e6b0249 in $TESTTMP/a (glob)
  details: $TESTTMP/a?cmd=changeset;node=485b4e6b0249
  summary: merged
  
  diffs (7 lines):
  
  diff -r ba677d0156c1 -r 485b4e6b0249 b
  --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
  +++ b/b	Thu Jan 01 00:00:00 1970 +0000
  @@ -0,0 +1,3 @@
  +x
  +b
  +y
  $ hg --cwd a rollback
  repository tip rolled back to revision 1 (undo push)