annotate tests/test-status-tracked-key.t @ 51977:42a116f1cdc1

branchmap-v3: introduce a "stop_rev" argument to `headsrevs`

The `headsrevs` method of the revlog already have a `revs` argument to compute
the headrevs of a limited set of heads. However, it disable the use of the
native compiled code to compute the heads, which slows down the branchmap v3
code a lot.

The branchmap v3 usage is actually quite constrained as we will always only
ignores a part at the top of the graph. So we could be significantly faster.

We start by making small change to the python side to improve the situation and
introduce the new API. More collaboration with the native code are coming later.

This massively speedup operation and close most of the remaining gaps between
branchmap-v3 and branchmap-v2. especially on repository with many revs like
mozilla-try. A small overhead remains mostly because the `headrevs` logic
currently has some inefficiently. We will look into them from there.

### benchmark.name                                 = hg.command.unbundle
  # bin-env-vars.hg.py-re2-module                  = default
  # benchmark.variants.issue6528                   = disabled
  # benchmark.variants.resource-usage              = default
  # benchmark.variants.reuse-external-delta-parent = yes
  # benchmark.variants.revs                        = any-1-extra-rev
  # benchmark.variants.source                      = unbundle
  # benchmark.variants.validate                    = default
  # benchmark.variants.verbosity                   = quiet

 ## data-env-vars.name                             = netbeans-2018-08-01-zstd-sparse-revlog
  # bin-env-vars.hg.flavor                         = default
branch-v2:        0.233711  ~~~~~
branch-v3 before: 0.368769  (+57.79%, +0.14)
branch-v3 after:  0.239857   (+2.63%, +0.01)
  # bin-env-vars.hg.flavor                         = rust
branch-v2:        0.235230  ~~~~~
branch-v3 before: 0.372460  (+58.34%, +0.14)
branch-v3 after:  0.240972   (+2.44%, +0.01)
 ## data-env-vars.name                             = netbeans-2018-08-01-ds2-pnm
  # bin-env-vars.hg.flavor                         = rust
branch-v2:        0.255586  ~~~~~
branch-v3 before: 0.318907  (+24.78%, +0.06)
branch-v3 after:  0.268560   (+5.08%, +0.01)

 ## data-env-vars.name                             = mozilla-central-2024-03-22-zstd-sparse-revlog
  # bin-env-vars.hg.flavor                         = default
branch-v2:        0.339010  ~~~~~
branch-v3 before: 0.349752   (+3.17%, +0.01)
branch-v3 after:  0.349389   (+3.06%, +0.01)
  # bin-env-vars.hg.flavor                         = rust
branch-v2:        0.346525  ~~~~~
branch-v3 before: 0.354300   (+2.24%, +0.01)
branch-v3 after:  0.355661   (+2.64%, +0.01)
 ## data-env-vars.name                             = mozilla-central-2024-03-22-ds2-pnm
  # bin-env-vars.hg.flavor                         = rust
branch-v2:        0.380202  ~~~~~
branch-v3 before: 0.396293   (+4.23%, +0.02)
branch-v3 after:  0.408851   (+7.54%, +0.03)

 ## data-env-vars.name                             = mozilla-unified-2024-03-22-zstd-sparse-revlog
  # bin-env-vars.hg.flavor                         = default
branch-v2:        0.412165  ~~~~~
branch-v3 before: 0.424769   (+3.06%, +0.01)
branch-v3 after:  0.427782   (+3.79%, +0.02)
  # bin-env-vars.hg.flavor                         = rust
branch-v2:        0.412397  ~~~~~
branch-v3 before: 0.421796   (+2.28%, +0.01)
branch-v3 after:  0.422354   (+2.41%, +0.01)
 ## data-env-vars.name                             = mozilla-unified-2024-03-22-ds2-pnm
  # bin-env-vars.hg.flavor                         = rust
branch-v2:        0.429501  ~~~~~
branch-v3 before: 0.443849   (+3.34%, +0.01)
branch-v3 after:  0.443197   (+3.19%, +0.01)

 ## data-env-vars.name                             = mozilla-try-2024-03-26-zstd-sparse-revlog
  # bin-env-vars.hg.flavor                         = default
branch-v2:        3.403171  ~~~~~
branch-v3 before: 6.234055  (+83.18%, +2.83)
branch-v3 after:  3.819477  (+12.23%, +0.42)
  # bin-env-vars.hg.flavor                         = rust
branch-v2:        3.454876  ~~~~~
branch-v3 before: 6.307813  (+82.58%, +2.85)
branch-v3 after:  3.590284   (+3.92%, +0.14)
 ## data-env-vars.name                             = mozilla-try-2024-03-26-ds2-pnm
  # bin-env-vars.hg.flavor                         = rust
branch-v2:        3.465435  ~~~~~
branch-v3 before: 5.176076  (+49.36%, +1.71)
branch-v3 after:  3.633278   (+4.84%, +0.17)

===============================
Test the "tracked hint" feature
===============================

The tracked hint feature provide a file that get updated when the set of tracked
files get updated.

basic setup

  $ cat << EOF >> $HGRCPATH
  > [format]
  > use-dirstate-tracked-hint=yes
  > EOF

  $ hg init tracked-hint-test
  $ cd tracked-hint-test
  $ hg debugbuilddag '.+10' -n
  $ hg log -G -T '{rev} {desc} {files}\n'
  o  10 r10 nf10
  |
  o  9 r9 nf9
  |
  o  8 r8 nf8
  |
  o  7 r7 nf7
  |
  o  6 r6 nf6
  |
  o  5 r5 nf5
  |
  o  4 r4 nf4
  |
  o  3 r3 nf3
  |
  o  2 r2 nf2
  |
  o  1 r1 nf1
  |
  o  0 r0 nf0
  
  $ hg up tip
  11 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ hg files
  nf0
  nf1
  nf10
  nf2
  nf3
  nf4
  nf5
  nf6
  nf7
  nf8
  nf9

key-file exists
-----------

The tracked hint file should exist

  $ ls -1 .hg/dirstate*
  .hg/dirstate
  .hg/dirstate-tracked-hint

key-file stay the same if the tracked set is unchanged
------------------------------------------------------

(copy its content for later comparison)

  $ cp .hg/dirstate-tracked-hint ../key-bck
  $ echo foo >> nf0
  $ sleep 1
  $ hg status
  M nf0
  $ diff --brief .hg/dirstate-tracked-hint ../key-bck
  $ hg revert -C nf0
  $ sleep 1
  $ hg status
  $ diff --brief .hg/dirstate-tracked-hint ../key-bck

key-file change if the tracked set is changed manually
------------------------------------------------------

adding a file to tracking

  $ cp .hg/dirstate-tracked-hint ../key-bck
  $ echo x > x
  $ hg add x
  $ diff --brief .hg/dirstate-tracked-hint ../key-bck
  Files .hg/dirstate-tracked-hint and ../key-bck differ
  [1]

remove a file from tracking
(forget)

  $ cp .hg/dirstate-tracked-hint ../key-bck
  $ hg forget x
  $ diff --brief .hg/dirstate-tracked-hint ../key-bck
  Files .hg/dirstate-tracked-hint and ../key-bck differ
  [1]

(remove)

  $ cp .hg/dirstate-tracked-hint ../key-bck
  $ hg remove nf1
  $ diff --brief .hg/dirstate-tracked-hint ../key-bck
  Files .hg/dirstate-tracked-hint and ../key-bck differ
  [1]

key-file changes on revert (when applicable)
--------------------------------------------

  $ cp .hg/dirstate-tracked-hint ../key-bck
  $ hg status
  R nf1
  ? x
  $ hg revert --all
  undeleting nf1
  $ hg status
  ? x
  $ diff --brief .hg/dirstate-tracked-hint ../key-bck
  Files .hg/dirstate-tracked-hint and ../key-bck differ
  [1]


`hg update` does affect the key-file (when needed)
--------------------------------------------------

update changing the tracked set

(removing)

  $ cp .hg/dirstate-tracked-hint ../key-bck
  $ hg status --rev . --rev '.#generations[-1]'
  R nf10
  $ hg up '.#generations[-1]'
  0 files updated, 0 files merged, 1 files removed, 0 files unresolved
  $ diff --brief .hg/dirstate-tracked-hint ../key-bck
  Files .hg/dirstate-tracked-hint and ../key-bck differ
  [1]

(adding)

  $ cp .hg/dirstate-tracked-hint ../key-bck
  $ hg status --rev . --rev '.#generations[1]'
  A nf10
  $ hg up '.#generations[1]'
  1 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ diff --brief .hg/dirstate-tracked-hint ../key-bck
  Files .hg/dirstate-tracked-hint and ../key-bck differ
  [1]

update not affecting the tracked set

  $ echo foo >> nf0
  $ hg commit -m foo

  $ cp .hg/dirstate-tracked-hint ../key-bck
  $ hg status --rev . --rev '.#generations[-1]'
  M nf0
  $ hg up '.#generations[-1]'
  1 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ diff --brief .hg/dirstate-tracked-hint ../key-bck

Test upgrade and downgrade
==========================

  $ test -f .hg/dirstate-tracked-hint
  $ hg debugrequires | grep 'tracked'
  dirstate-tracked-key-v1

downgrade

  $ hg debugupgraderepo --config format.use-dirstate-tracked-hint=no --run --quiet
  upgrade will perform the following actions:
  
  requirements
     preserved: * (glob)
     removed: dirstate-tracked-key-v1
  
  no revlogs to process
  
  $ test -f .hg/dirstate-tracked-hint
  [1]
  $ hg debugrequires | grep 'tracked'
  [1]

upgrade

  $ hg debugupgraderepo --config format.use-dirstate-tracked-hint=yes --run --quiet
  upgrade will perform the following actions:
  
  requirements
     preserved: * (glob)
     added: dirstate-tracked-key-v1
  
  no revlogs to process
  
  $ test -f .hg/dirstate-tracked-hint
  $ hg debugrequires | grep 'tracked'
  dirstate-tracked-key-v1
  $ cd ..

Test automatic upgrade and downgrade
------------------------------------

create an initial repository

  $ hg init auto-upgrade \
  > --config format.use-dirstate-tracked-hint=no
  $ hg debugbuilddag -R auto-upgrade --new-file .+5
  $ hg -R auto-upgrade update
  6 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ hg debugformat -R auto-upgrade | grep tracked
  tracked-hint:        no

upgrade it to dirstate-tracked-hint automatically

  $ hg status -R auto-upgrade \
  > --config format.use-dirstate-tracked-hint.automatic-upgrade-of-mismatching-repositories=yes \
  > --config format.use-dirstate-tracked-hint=yes
  automatically upgrading repository to the `tracked-hint` feature
  (see `hg help config.format.use-dirstate-tracked-hint` for details)
  $ hg debugformat -R auto-upgrade | grep tracked
  tracked-hint:       yes

rhg supports this feature

  $ hg status -R auto-upgrade \
  > --config format.use-dirstate-tracked-hint=yes --config rhg.on-unsupported=abort

downgrade it from dirstate-tracked-hint automatically

  $ hg status -R auto-upgrade \
  > --config format.use-dirstate-tracked-hint.automatic-upgrade-of-mismatching-repositories=yes \
  > --config format.use-dirstate-tracked-hint=no
  automatically downgrading repository from the `tracked-hint` feature
  (see `hg help config.format.use-dirstate-tracked-hint` for details)
  $ hg debugformat -R auto-upgrade | grep tracked
  tracked-hint:        no