annotate tests/test-fix-metadata.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)

A python hook for "hg fix" that prints out the number of files and revisions
that were affected, along with which fixer tools were applied. Also checks how
many times it sees a specific key generated by one of the fixer tools defined
below.

  $ cat >> $TESTTMP/postfixhook.py <<EOF
  > import collections
  > def file(ui, repo, rev=None, path=b'', metadata=None, **kwargs):
  >   ui.status(b'fixed %s in revision %d using %s\n' %
  >             (path, rev, b', '.join(metadata.keys())))
  > def summarize(ui, repo, replacements=None, wdirwritten=False,
  >               metadata=None, **kwargs):
  >     counts = collections.defaultdict(int)
  >     keys = 0
  >     for fixername, metadatalist in metadata.items():
  >         for metadata in metadatalist:
  >             if metadata is None:
  >                 continue
  >             counts[fixername] += 1
  >             if 'key' in metadata:
  >                 keys += 1
  >     ui.status(b'saw "key" %d times\n' % (keys,))
  >     for name, count in sorted(counts.items()):
  >         ui.status(b'fixed %d files with %s\n' % (count, name))
  >     if replacements:
  >         ui.status(b'fixed %d revisions\n' % (len(replacements),))
  >     if wdirwritten:
  >         ui.status(b'fixed the working copy\n')
  > EOF

Some mock output for fixer tools that demonstrate what could go wrong with
expecting the metadata output format.

  $ printf 'new content\n' > $TESTTMP/missing
  $ printf 'not valid json\0new content\n' > $TESTTMP/invalid
  $ printf '{"key": "value"}\0new content\n' > $TESTTMP/valid

Configure some fixer tools based on the output defined above, and enable the
hooks defined above. Disable parallelism to make output of the parallel file
processing phase stable.

  $ cat >> $HGRCPATH <<EOF
  > [extensions]
  > fix =
  > [fix]
  > metadatafalse:command=cat $TESTTMP/missing
  > metadatafalse:pattern=metadatafalse
  > metadatafalse:metadata=false
  > missing:command=cat $TESTTMP/missing
  > missing:pattern=missing
  > missing:metadata=true
  > invalid:command=cat $TESTTMP/invalid
  > invalid:pattern=invalid
  > invalid:metadata=true
  > valid:command=cat $TESTTMP/valid
  > valid:pattern=valid
  > valid:metadata=true
  > [hooks]
  > postfixfile = python:$TESTTMP/postfixhook.py:file
  > postfix = python:$TESTTMP/postfixhook.py:summarize
  > [worker]
  > enabled=false
  > EOF

See what happens when we execute each of the fixer tools. Some print warnings,
some write back to the file.

  $ hg init repo
  $ cd repo

  $ printf "old content\n" > metadatafalse
  $ printf "old content\n" > invalid
  $ printf "old content\n" > missing
  $ printf "old content\n" > valid
  $ hg add -q

  $ hg fix -w
  ignored invalid output from fixer tool: invalid
  fixed metadatafalse in revision 2147483647 using metadatafalse
  ignored invalid output from fixer tool: missing
  fixed valid in revision 2147483647 using valid
  saw "key" 1 times
  fixed 1 files with valid
  fixed the working copy

  $ cat metadatafalse
  new content
  $ cat missing
  old content
  $ cat invalid
  old content
  $ cat valid
  new content

  $ cd ..