view tests/test-convert-cvs-detectmerge.t @ 44118:f81c17ec303c

hgdemandimport: apply lazy module loading to sys.meta_path finders

Python's `sys.meta_path` finders are the primary objects whose job it
is to find a module at import time. When `import` is called, Python
iterates objects in this list and calls `o.find_spec(...)` to find
a `ModuleSpec` (or None if the module couldn't be found by that
finder). If no meta path finder can find a module, import fails.

One of the default meta path finders is `PathFinder`. Its job is to
import modules from the filesystem and is probably the most important
importer. This finder looks at `sys.path` and `sys.path_hooks` to do
its job.

The `ModuleSpec` returned by `MetaPathImporter.find_spec()` has a
`loader` attribute, which defines the concrete module loader to use.
`sys.path_hooks` is a hook point for teaching `PathFinder` to
instantiate custom loader types.

Previously, we injected a custom `sys.path_hook` that told `PathFinder`
to wrap the default loaders with a loader that creates a module object
that is lazy.

This approach worked. But its main limitation was that it only applied
to the `PathFinder` meta path importer. There are other meta path
importers that are registered. And in the case of PyOxidizer loading
modules from memory, `PathFinder` doesn't come into play since
PyOxidizer's own meta path importer was handling all imports.

This commit changes our approach to lazy module loading by proxying
all meta path importers. Specifically, we overload the `find_spec()`
method to swap in a wrapped loader on the `ModuleSpec` before it
is returned. The end result of this is all meta path importers should
be lazy.

As much as I would have loved to utilize .__class__ manipulation to
achieve this, some meta path importers are implemented in C/Rust
in such a way that they cannot be monkeypatched. This is why we
use __getattribute__ to define a proxy.

Also, this change could theoretically open us up to regressions in
meta path importers whose loader is creating module objects which
can't be monkeypatched. But I'm not aware of any of these in the
wild. So I think we'll be safe.

According to hyperfine, this change yields a decent startup time win of
5-6ms:

```
Benchmark #1: ~/.pyenv/versions/3.6.10/bin/python ./hg version
  Time (mean ± σ):      86.8 ms ±   0.5 ms    [User: 78.0 ms, System: 8.7 ms]
  Range (min … max):    86.0 ms …  89.1 ms    50 runs

  Time (mean ± σ):      81.1 ms ±   2.7 ms    [User: 74.5 ms, System: 6.5 ms]
  Range (min … max):    77.8 ms …  90.5 ms    50 runs

Benchmark #2: ~/.pyenv/versions/3.7.6/bin/python ./hg version
  Time (mean ± σ):      78.9 ms ±   0.6 ms    [User: 70.2 ms, System: 8.7 ms]
  Range (min … max):    78.1 ms …  81.2 ms    50 runs

  Time (mean ± σ):      73.4 ms ±   0.6 ms    [User: 65.3 ms, System: 8.0 ms]
  Range (min … max):    72.4 ms …  75.7 ms    50 runs

Benchmark #3: ~/.pyenv/versions/3.8.1/bin/python ./hg version
  Time (mean ± σ):      78.1 ms ±   0.6 ms    [User: 70.2 ms, System: 7.9 ms]
  Range (min … max):    77.4 ms …  80.9 ms    50 runs

  Time (mean ± σ):      72.1 ms ±   0.4 ms    [User: 64.4 ms, System: 7.6 ms]
  Range (min … max):    71.4 ms …  74.1 ms    50 runs
```

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

#require cvs

Test config convert.cvsps.mergefrom config setting.
(Should test similar mergeto feature, but I don't understand it yet.)
Requires builtin cvsps.

  $ CVSROOT=`pwd`/cvsrepo
  $ export CVSROOT

  $ cvscall()
  > {
  >     cvs -f "$@"
  > }

output of 'cvs ci' varies unpredictably, so just discard it
XXX copied from test-convert-cvs-synthetic

  $ cvsci()
  > {
  >     sleep 1
  >     cvs -f ci "$@" > /dev/null
  > }

XXX copied from test-convert-cvs-synthetic

  $ cat <<EOF >> $HGRCPATH
  > [extensions]
  > convert =
  > [convert]
  > cvsps.cache = 0
  > cvsps.mergefrom = \[MERGE from (\S+)\]
  > EOF

create cvs repository with one project

  $ cvscall -q -d "$CVSROOT" init
  $ mkdir cvsrepo/proj

populate cvs repository

  $ cvscall -Q co proj
  $ cd proj
  $ touch file1
  $ cvscall -Q add file1
  $ cvsci -m"add file1 on trunk"
  cvs commit: Examining .

create two release branches

  $ cvscall -q tag -b v1_0
  T file1
  $ cvscall -q tag -b v1_1
  T file1

modify file1 on branch v1_0

  $ cvscall -Q update -rv1_0
  $ sleep 1
  $ echo "change" >> file1
  $ cvsci -m"add text"
  cvs commit: Examining .

make unrelated change on v1_1

  $ cvscall -Q update -rv1_1
  $ touch unrelated
  $ cvscall -Q add unrelated
  $ cvsci -m"unrelated change"
  cvs commit: Examining .

merge file1 to v1_1

  $ cvscall -Q update -jv1_0
  RCS file: $TESTTMP/cvsrepo/proj/file1,v
  retrieving revision 1.1
  retrieving revision 1.1.2.1
  Merging differences between 1.1 and 1.1.2.1 into file1
  $ cvsci -m"add text [MERGE from v1_0]"
  cvs commit: Examining .

merge change to trunk

  $ cvscall -Q update -A
  $ cvscall -Q update -jv1_1
  RCS file: $TESTTMP/cvsrepo/proj/file1,v
  retrieving revision 1.1
  retrieving revision 1.1.4.1
  Merging differences between 1.1 and 1.1.4.1 into file1
  $ cvsci -m"add text [MERGE from v1_1]"
  cvs commit: Examining .

non-merged change on trunk

  $ echo "foo" > file2
  $ cvscall -Q add file2
  $ cvsci -m"add file2 on trunk" file2

this will create rev 1.3
change on trunk to backport

  $ echo "backport me" >> file1
  $ cvsci -m"add other text" file1
  $ cvscall log file1
  
  RCS file: $TESTTMP/cvsrepo/proj/file1,v
  Working file: file1
  head: 1.3
  branch:
  locks: strict
  access list:
  symbolic names:
  	v1_1: 1.1.0.4
  	v1_0: 1.1.0.2
  keyword substitution: kv
  total revisions: 5;	selected revisions: 5
  description:
  ----------------------------
  revision 1.3
  date: * (glob)
  add other text
  ----------------------------
  revision 1.2
  date: * (glob)
  add text [MERGE from v1_1]
  ----------------------------
  revision 1.1
  date: * (glob)
  branches:  1.1.2;  1.1.4;
  add file1 on trunk
  ----------------------------
  revision 1.1.4.1
  date: * (glob)
  add text [MERGE from v1_0]
  ----------------------------
  revision 1.1.2.1
  date: * (glob)
  add text
  =============================================================================

XXX how many ways are there to spell "trunk" with CVS?
backport trunk change to v1_1

  $ cvscall -Q update -rv1_1
  $ cvscall -Q update -j1.2 -j1.3 file1
  RCS file: $TESTTMP/cvsrepo/proj/file1,v
  retrieving revision 1.2
  retrieving revision 1.3
  Merging differences between 1.2 and 1.3 into file1
  $ cvsci -m"add other text [MERGE from HEAD]" file1

fix bug on v1_1, merge to trunk with error

  $ cvscall -Q update -rv1_1
  $ echo "merge forward" >> file1
  $ cvscall -Q tag unmerged
  $ cvsci -m"fix file1"
  cvs commit: Examining .
  $ cvscall -Q update -A
  $ cvscall -Q update -junmerged -jv1_1
  RCS file: $TESTTMP/cvsrepo/proj/file1,v
  retrieving revision 1.1.4.2
  retrieving revision 1.1.4.3
  Merging differences between 1.1.4.2 and 1.1.4.3 into file1

note the typo in the commit log message

  $ cvsci -m"fix file1 [MERGE from v1-1]"
  cvs commit: Examining .
  $ cvs -Q tag -d unmerged

convert to hg

  $ cd ..
  $ hg convert proj proj.hg
  initializing destination proj.hg repository
  connecting to $TESTTMP/cvsrepo
  scanning source...
  collecting CVS rlog
  12 log entries
  creating changesets
  warning: CVS commit message references non-existent branch 'v1-1':
  fix file1 [MERGE from v1-1]
  10 changeset entries
  sorting...
  converting...
  9 add file1 on trunk
  8 unrelated change
  7 add text
  6 add text [MERGE from v1_0]
  5 add text [MERGE from v1_1]
  4 add file2 on trunk
  3 add other text
  2 add other text [MERGE from HEAD]
  1 fix file1
  0 fix file1 [MERGE from v1-1]

complete log

  $ template="{rev}: '{branches}' {desc}\n"
  $ hg -R proj.hg log --template="$template"
  9: '' fix file1 [MERGE from v1-1]
  8: 'v1_1' fix file1
  7: 'v1_1' add other text [MERGE from HEAD]
  6: '' add other text
  5: '' add file2 on trunk
  4: '' add text [MERGE from v1_1]
  3: 'v1_1' add text [MERGE from v1_0]
  2: 'v1_0' add text
  1: 'v1_1' unrelated change
  0: '' add file1 on trunk

graphical log

  $ hg -R proj.hg log -G --template="$template"
  o  9: '' fix file1 [MERGE from v1-1]
  |
  | o  8: 'v1_1' fix file1
  | |
  | o  7: 'v1_1' add other text [MERGE from HEAD]
  |/|
  o |  6: '' add other text
  | |
  o |  5: '' add file2 on trunk
  | |
  o |  4: '' add text [MERGE from v1_1]
  |\|
  | o    3: 'v1_1' add text [MERGE from v1_0]
  | |\
  +---o  2: 'v1_0' add text
  | |
  | o  1: 'v1_1' unrelated change
  |/
  o  0: '' add file1 on trunk