sparse: override dirstate.walk() instead of dirstate._ignore

Instead of treating files that are outside the sparse config as
ignored, this makes it so we list only those that are within the
sparse config by passing the sparse matcher to dirstate.walk().

Once we add support for narrow (sparseness applied to history, not
just working copy), we will need to do a similar restriction of the
walk over manifests, so this will be more consistent then. It also
simplifies the code a bit.

Note that a side-effect of this change is that files outside the
sparse config used to be listed as ignored, but they will now not be
listed at all. This can be seen in the test case where "hg purge" no
longer has any effect because it doesn't see that the files outside
the space config exist. To fix that, I think we should add an option
to dirstate.walk() to walk outside the sparse config. We might expose
that to the user as --no-sparse flag to e.g. "hg status" and "hg
purge", but that's work for another day.

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

hgext/sparse.py

@@ -1,362 +1,337
 # sparse.py - allow sparse checkouts of the working directory
 #
 # Copyright 2014 Facebook, Inc.
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 """allow sparse checkouts of the working directory (EXPERIMENTAL)
 
 (This extension is not yet protected by backwards compatibility
 guarantees. Any aspect may break in future releases until this
 notice is removed.)
 
 This extension allows the working directory to only consist of a
 subset of files for the revision. This allows specific files or
 directories to be explicitly included or excluded. Many repository
 operations have performance proportional to the number of files in
 the working directory. So only realizing a subset of files in the
 working directory can improve performance.
 
 Sparse Config Files
 -------------------
 
 The set of files that are part of a sparse checkout are defined by
 a sparse config file. The file defines 3 things: includes (files to
 include in the sparse checkout), excludes (files to exclude from the
 sparse checkout), and profiles (links to other config files).
 
 The file format is newline delimited. Empty lines and lines beginning
 with ``#`` are ignored.
 
 Lines beginning with ``%include `` denote another sparse config file
 to include. e.g. ``%include tests.sparse``. The filename is relative
 to the repository root.
 
 The special lines ``[include]`` and ``[exclude]`` denote the section
 for includes and excludes that follow, respectively. It is illegal to
 have ``[include]`` after ``[exclude]``. If no sections are defined,
 entries are assumed to be in the ``[include]`` section.
 
 Non-special lines resemble file patterns to be added to either includes
 or excludes. The syntax of these lines is documented by :hg:`help patterns`.
 Patterns are interpreted as ``glob:`` by default and match against the
 root of the repository.
 
 Exclusion patterns take precedence over inclusion patterns. So even
 if a file is explicitly included, an ``[exclude]`` entry can remove it.
 
 For example, say you have a repository with 3 directories, ``frontend/``,
 ``backend/``, and ``tools/``. ``frontend/`` and ``backend/`` correspond
 to different projects and it is uncommon for someone working on one
 to need the files for the other. But ``tools/`` contains files shared
 between both projects. Your sparse config files may resemble::
 
   # frontend.sparse
   frontend/**
   tools/**
 
   # backend.sparse
   backend/**
   tools/**
 
 Say the backend grows in size. Or there's a directory with thousands
 of files you wish to exclude. You can modify the profile to exclude
 certain files::
 
   [include]
   backend/**
   tools/**
 
   [exclude]
   tools/tests/**
 """
 
 from __future__ import absolute_import
 
 from mercurial.i18n import _
 from mercurial import (
     cmdutil,
     commands,
     dirstate,
     error,
     extensions,
     hg,
     match as matchmod,
     registrar,
     sparse,
     util,
 )
 
 # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for
 # extensions which SHIP WITH MERCURIAL. Non-mainline extensions should
 # be specifying the version(s) of Mercurial they are tested with, or
 # leave the attribute unspecified.
 testedwith = 'ships-with-hg-core'
 
 cmdtable = {}
 command = registrar.command(cmdtable)
 
 def extsetup(ui):
     sparse.enabled = True
 
     _setupclone(ui)
     _setuplog(ui)
     _setupadd(ui)
     _setupdirstate(ui)
 
 def replacefilecache(cls, propname, replacement):
     """Replace a filecache property with a new class. This allows changing the
     cache invalidation condition."""
     origcls = cls
     assert callable(replacement)
     while cls is not object:
         if propname in cls.__dict__:
             orig = cls.__dict__[propname]
             setattr(cls, propname, replacement(orig))
             break
         cls = cls.__bases__[0]
 
     if cls is object:
         raise AttributeError(_("type '%s' has no property '%s'") % (origcls,
                              propname))
 
 def _setuplog(ui):
     entry = commands.table['^log|history']
     entry[1].append(('', 'sparse', None,
         "limit to changesets affecting the sparse checkout"))
 
     def _logrevs(orig, repo, opts):
         revs = orig(repo, opts)
         if opts.get('sparse'):
             sparsematch = sparse.matcher(repo)
             def ctxmatch(rev):
                 ctx = repo[rev]
                 return any(f for f in ctx.files() if sparsematch(f))
             revs = revs.filter(ctxmatch)
         return revs
     extensions.wrapfunction(cmdutil, '_logrevs', _logrevs)
 
 def _clonesparsecmd(orig, ui, repo, *args, **opts):
     include_pat = opts.get('include')
     exclude_pat = opts.get('exclude')
     enableprofile_pat = opts.get('enable_profile')
     include = exclude = enableprofile = False
     if include_pat:
         pat = include_pat
         include = True
     if exclude_pat:
         pat = exclude_pat
         exclude = True
     if enableprofile_pat:
         pat = enableprofile_pat
         enableprofile = True
     if sum([include, exclude, enableprofile]) > 1:
         raise error.Abort(_("too many flags specified."))
     if include or exclude or enableprofile:
         def clonesparse(orig, self, node, overwrite, *args, **kwargs):
             sparse.updateconfig(self.unfiltered(), pat, {}, include=include,
                                 exclude=exclude, enableprofile=enableprofile)
             return orig(self, node, overwrite, *args, **kwargs)
         extensions.wrapfunction(hg, 'updaterepo', clonesparse)
     return orig(ui, repo, *args, **opts)
 
 def _setupclone(ui):
     entry = commands.table['^clone']
     entry[1].append(('', 'enable-profile', [],
                     'enable a sparse profile'))
     entry[1].append(('', 'include', [],
                     'include sparse pattern'))
     entry[1].append(('', 'exclude', [],
                     'exclude sparse pattern'))
     extensions.wrapcommand(commands.table, 'clone', _clonesparsecmd)
 
 def _setupadd(ui):
     entry = commands.table['^add']
     entry[1].append(('s', 'sparse', None,
                     'also include directories of added files in sparse config'))
 
     def _add(orig, ui, repo, *pats, **opts):
         if opts.get('sparse'):
             dirs = set()
             for pat in pats:
                 dirname, basename = util.split(pat)
                 dirs.add(dirname)
             sparse.updateconfig(repo, list(dirs), opts, include=True)
         return orig(ui, repo, *pats, **opts)
 
     extensions.wrapcommand(commands.table, 'add', _add)
 
 def _setupdirstate(ui):
     """Modify the dirstate to prevent stat'ing excluded files,
     and to prevent modifications to files outside the checkout.
     """
 
-    # The atrocity below is needed to wrap dirstate._ignore. It is a cached
-    # property, which means normal function wrapping doesn't work.
-    class ignorewrapper(object):
-        def __init__(self, orig):
-            self.orig = orig
-            self.origignore = None
-            self.func = None
-            self.sparsematch = None
-
-        def __get__(self, obj, type=None):
-            origignore = self.orig.__get__(obj)
+    def walk(orig, self, match, subrepos, unknown, ignored, full=True):
+        match = matchmod.intersectmatchers(match, self._sparsematcher)
+        return orig(self, match, subrepos, unknown, ignored, full)
 
-            sparsematch = obj._sparsematcher
-            if sparsematch.always():
-                return origignore
-
-            if self.sparsematch != sparsematch or self.origignore != origignore:
-                self.func = matchmod.unionmatcher([
-                    origignore, matchmod.negatematcher(sparsematch)])
-                self.sparsematch = sparsematch
-                self.origignore = origignore
-            return self.func
-
-        def __set__(self, obj, value):
-            return self.orig.__set__(obj, value)
-
-        def __delete__(self, obj):
-            return self.orig.__delete__(obj)
-
-    replacefilecache(dirstate.dirstate, '_ignore', ignorewrapper)
+    extensions.wrapfunction(dirstate.dirstate, 'walk', walk)
 
     # dirstate.rebuild should not add non-matching files
     def _rebuild(orig, self, parent, allfiles, changedfiles=None):
         matcher = self._sparsematcher
         if not matcher.always():
             allfiles = allfiles.matches(matcher)
             if changedfiles:
                 changedfiles = [f for f in changedfiles if matcher(f)]
 
             if changedfiles is not None:
                 # In _rebuild, these files will be deleted from the dirstate
                 # when they are not found to be in allfiles
                 dirstatefilestoremove = set(f for f in self if not matcher(f))
                 changedfiles = dirstatefilestoremove.union(changedfiles)
 
         return orig(self, parent, allfiles, changedfiles)
     extensions.wrapfunction(dirstate.dirstate, 'rebuild', _rebuild)
 
     # Prevent adding files that are outside the sparse checkout
     editfuncs = ['normal', 'add', 'normallookup', 'copy', 'remove', 'merge']
     hint = _('include file with `hg debugsparse --include <pattern>` or use ' +
              '`hg add -s <file>` to include file directory while adding')
     for func in editfuncs:
         def _wrapper(orig, self, *args):
             sparsematch = self._sparsematcher
             if not sparsematch.always():
                 for f in args:
                     if (f is not None and not sparsematch(f) and
                         f not in self):
                         raise error.Abort(_("cannot add '%s' - it is outside "
                                             "the sparse checkout") % f,
                                           hint=hint)
             return orig(self, *args)
         extensions.wrapfunction(dirstate.dirstate, func, _wrapper)
 
 @command('^debugsparse', [
     ('I', 'include', False, _('include files in the sparse checkout')),
     ('X', 'exclude', False, _('exclude files in the sparse checkout')),
     ('d', 'delete', False, _('delete an include/exclude rule')),
     ('f', 'force', False, _('allow changing rules even with pending changes')),
     ('', 'enable-profile', False, _('enables the specified profile')),
     ('', 'disable-profile', False, _('disables the specified profile')),
     ('', 'import-rules', False, _('imports rules from a file')),
     ('', 'clear-rules', False, _('clears local include/exclude rules')),
     ('', 'refresh', False, _('updates the working after sparseness changes')),
     ('', 'reset', False, _('makes the repo full again')),
     ] + commands.templateopts,
     _('[--OPTION] PATTERN...'))
 def debugsparse(ui, repo, *pats, **opts):
     """make the current checkout sparse, or edit the existing checkout
 
     The sparse command is used to make the current checkout sparse.
     This means files that don't meet the sparse condition will not be
     written to disk, or show up in any working copy operations. It does
     not affect files in history in any way.
 
     Passing no arguments prints the currently applied sparse rules.
 
     --include and --exclude are used to add and remove files from the sparse
     checkout. The effects of adding an include or exclude rule are applied
     immediately. If applying the new rule would cause a file with pending
     changes to be added or removed, the command will fail. Pass --force to
     force a rule change even with pending changes (the changes on disk will
     be preserved).
 
     --delete removes an existing include/exclude rule. The effects are
     immediate.
 
     --refresh refreshes the files on disk based on the sparse rules. This is
     only necessary if .hg/sparse was changed by hand.
 
     --enable-profile and --disable-profile accept a path to a .hgsparse file.
     This allows defining sparse checkouts and tracking them inside the
     repository. This is useful for defining commonly used sparse checkouts for
     many people to use. As the profile definition changes over time, the sparse
     checkout will automatically be updated appropriately, depending on which
     changeset is checked out. Changes to .hgsparse are not applied until they
     have been committed.
 
     --import-rules accepts a path to a file containing rules in the .hgsparse
     format, allowing you to add --include, --exclude and --enable-profile rules
     in bulk. Like the --include, --exclude and --enable-profile switches, the
     changes are applied immediately.
 
     --clear-rules removes all local include and exclude rules, while leaving
     any enabled profiles in place.
 
     Returns 0 if editing the sparse checkout succeeds.
     """
     include = opts.get('include')
     exclude = opts.get('exclude')
     force = opts.get('force')
     enableprofile = opts.get('enable_profile')
     disableprofile = opts.get('disable_profile')
     importrules = opts.get('import_rules')
     clearrules = opts.get('clear_rules')
     delete = opts.get('delete')
     refresh = opts.get('refresh')
     reset = opts.get('reset')
     count = sum([include, exclude, enableprofile, disableprofile, delete,
                  importrules, refresh, clearrules, reset])
     if count > 1:
         raise error.Abort(_("too many flags specified"))
 
     if count == 0:
         if repo.vfs.exists('sparse'):
             ui.status(repo.vfs.read("sparse") + "\n")
             temporaryincludes = sparse.readtemporaryincludes(repo)
             if temporaryincludes:
                 ui.status(_("Temporarily Included Files (for merge/rebase):\n"))
                 ui.status(("\n".join(temporaryincludes) + "\n"))
         else:
             ui.status(_('repo is not sparse\n'))
         return
 
     if include or exclude or delete or reset or enableprofile or disableprofile:
         sparse.updateconfig(repo, pats, opts, include=include, exclude=exclude,
                             reset=reset, delete=delete,
                             enableprofile=enableprofile,
                             disableprofile=disableprofile, force=force)
 
     if importrules:
         sparse.importfromfiles(repo, opts, pats, force=force)
 
     if clearrules:
         sparse.clearrules(repo, force=force)
 
     if refresh:
         try:
             wlock = repo.wlock()
             fcounts = map(
                 len,
                 sparse.refreshwdir(repo, repo.status(), sparse.matcher(repo),
                                    force=force))
             sparse.printchanges(ui, opts, added=fcounts[0], dropped=fcounts[1],
                                 conflicting=fcounts[2])
         finally:
             wlock.release()

tests/test-sparse.t

@@ -1,365 +1,370
 test sparse
 
   $ hg init myrepo
   $ cd myrepo
   $ cat > .hg/hgrc <<EOF
   > [extensions]
   > sparse=
   > strip=
   > EOF
 
   $ echo a > show
   $ echo x > hide
   $ hg ci -Aqm 'initial'
 
   $ echo b > show
   $ echo y > hide
   $ echo aa > show2
   $ echo xx > hide2
   $ hg ci -Aqm 'two'
 
 Verify basic --include
 
   $ hg up -q 0
   $ hg debugsparse --include 'hide'
   $ ls
   hide
 
 Absolute paths outside the repo should just be rejected
 
 #if no-windows
   $ hg debugsparse --include /foo/bar
   warning: paths cannot start with /, ignoring: ['/foo/bar']
   $ hg debugsparse --include '$TESTTMP/myrepo/hide'
 
   $ hg debugsparse --include '/root'
   warning: paths cannot start with /, ignoring: ['/root']
 #else
 TODO: See if this can be made to fail the same way as on Unix
   $ hg debugsparse --include /c/foo/bar
   abort: c:/foo/bar not under root '$TESTTMP/myrepo' (glob)
   [255]
   $ hg debugsparse --include '$TESTTMP/myrepo/hide'
 
   $ hg debugsparse --include '/c/root'
   abort: c:/root not under root '$TESTTMP/myrepo' (glob)
   [255]
 #endif
 
 Verify commiting while sparse includes other files
 
   $ echo z > hide
   $ hg ci -Aqm 'edit hide'
   $ ls
   hide
   $ hg manifest
   hide
   show
 
 Verify --reset brings files back
 
   $ hg debugsparse --reset
   $ ls
   hide
   show
   $ cat hide
   z
   $ cat show
   a
 
 Verify 'hg debugsparse' default output
 
   $ hg up -q null
   $ hg debugsparse --include 'show*'
 
   $ hg debugsparse
   [include]
   show*
   
 Verify update only writes included files
 
   $ hg up -q 0
   $ ls
   show
 
   $ hg up -q 1
   $ ls
   show
   show2
 
 Verify status only shows included files
 
   $ touch hide
   $ touch hide3
   $ echo c > show
   $ hg status
   M show
 
 Adding an excluded file should fail
 
   $ hg add hide3
   abort: cannot add 'hide3' - it is outside the sparse checkout
   (include file with `hg debugsparse --include <pattern>` or use `hg add -s <file>` to include file directory while adding)
   [255]
 
 Verify deleting sparseness while a file has changes fails
 
   $ hg debugsparse --delete 'show*'
   pending changes to 'hide'
   abort: cannot change sparseness due to pending changes (delete the files or use --force to bring them back dirty)
   [255]
 
 Verify deleting sparseness with --force brings back files
 
   $ hg debugsparse --delete -f 'show*'
   pending changes to 'hide'
   $ ls
   hide
   hide2
   hide3
   show
   show2
   $ hg st
   M hide
   M show
   ? hide3
 
 Verify editing sparseness fails if pending changes
 
   $ hg debugsparse --include 'show*'
   pending changes to 'hide'
   abort: could not update sparseness due to pending changes
   [255]
 
 Verify adding sparseness hides files
 
   $ hg debugsparse --exclude -f 'hide*'
   pending changes to 'hide'
   $ ls
   hide
   hide3
   show
   show2
   $ hg st
   M show
 
   $ hg up -qC .
+TODO: add an option to purge to also purge files outside the sparse config?
   $ hg purge --all --config extensions.purge=
   $ ls
+  hide
+  hide3
   show
   show2
+For now, manually remove the files
+  $ rm hide hide3
 
 Verify rebase temporarily includes excluded files
 
   $ hg rebase -d 1 -r 2 --config extensions.rebase=
   rebasing 2:b91df4f39e75 "edit hide" (tip)
   temporarily included 1 file(s) in the sparse checkout for merging
   merging hide
   warning: conflicts while merging hide! (edit, then use 'hg resolve --mark')
   unresolved conflicts (see hg resolve, then hg rebase --continue)
   [1]
 
   $ hg debugsparse
   [exclude]
   hide*
   
   Temporarily Included Files (for merge/rebase):
   hide
 
   $ cat hide
   <<<<<<< dest:   39278f7c08a9 - test: two
   y
   =======
   z
   >>>>>>> source: b91df4f39e75 - test: edit hide
 
 Verify aborting a rebase cleans up temporary files
 
   $ hg rebase --abort --config extensions.rebase=
   cleaned up 1 temporarily added file(s) from the sparse checkout
   rebase aborted
   $ rm hide.orig
 
   $ ls
   show
   show2
 
 Verify merge fails if merging excluded files
 
   $ hg up -q 1
   $ hg merge -r 2
   temporarily included 1 file(s) in the sparse checkout for merging
   merging hide
   warning: conflicts while merging hide! (edit, then use 'hg resolve --mark')
   0 files updated, 0 files merged, 0 files removed, 1 files unresolved
   use 'hg resolve' to retry unresolved file merges or 'hg update -C .' to abandon
   [1]
   $ hg debugsparse
   [exclude]
   hide*
   
   Temporarily Included Files (for merge/rebase):
   hide
 
   $ hg up -C .
   cleaned up 1 temporarily added file(s) from the sparse checkout
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ hg debugsparse
   [exclude]
   hide*
   
 
 Verify strip -k resets dirstate correctly
 
   $ hg status
   $ hg debugsparse
   [exclude]
   hide*
   
   $ hg log -r . -T '{rev}\n' --stat
   1
    hide  |  2 +-
    hide2 |  1 +
    show  |  2 +-
    show2 |  1 +
    4 files changed, 4 insertions(+), 2 deletions(-)
   
   $ hg strip -r . -k
   saved backup bundle to $TESTTMP/myrepo/.hg/strip-backup/39278f7c08a9-ce59e002-backup.hg (glob)
   $ hg status
   M show
   ? show2
 
 Verify rebase succeeds if all changed files are in sparse checkout
 
   $ hg commit -Aqm "add show2"
   $ hg rebase -d 1 --config extensions.rebase=
   rebasing 2:bdde55290160 "add show2" (tip)
   saved backup bundle to $TESTTMP/myrepo/.hg/strip-backup/bdde55290160-216ed9c6-rebase.hg (glob)
 
 Verify log --sparse only shows commits that affect the sparse checkout
 
   $ hg log -T '{rev} '
   2 1 0  (no-eol)
   $ hg log --sparse -T '{rev} '
   2 0  (no-eol)
 
 Test status on a file in a subdir
 
   $ mkdir -p dir1/dir2
   $ touch dir1/dir2/file
   $ hg debugsparse -I dir1/dir2
   $ hg status
   ? dir1/dir2/file
 
 Test that add -s adds dirs to sparse profile
 
   $ hg debugsparse --reset
   $ hg debugsparse --include empty
   $ hg debugsparse
   [include]
   empty
   
 
   $ mkdir add
   $ touch add/foo
   $ touch add/bar
   $ hg add add/foo
   abort: cannot add 'add/foo' - it is outside the sparse checkout
   (include file with `hg debugsparse --include <pattern>` or use `hg add -s <file>` to include file directory while adding)
   [255]
   $ hg add -s add/foo
   $ hg st
   A add/foo
   ? add/bar
   $ hg debugsparse
   [include]
   add
   empty
   
   $ hg add -s add/*
   add/foo already tracked!
   $ hg st
   A add/bar
   A add/foo
   $ hg debugsparse
   [include]
   add
   empty
   
 
   $ cd ..
 
 Test non-sparse repos work while sparse is loaded
   $ hg init sparserepo
   $ hg init nonsparserepo
   $ cd sparserepo
   $ cat > .hg/hgrc <<EOF
   > [extensions]
   > sparse=
   > EOF
   $ cd ../nonsparserepo
   $ echo x > x && hg add x && hg commit -qAm x
   $ cd ../sparserepo
   $ hg clone ../nonsparserepo ../nonsparserepo2
   updating to branch default
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
 
 Test debugrebuilddirstate
   $ cd ../sparserepo
   $ touch included
   $ touch excluded
   $ hg add included excluded
   $ hg commit -m 'a commit' -q
   $ cp .hg/dirstate ../dirstateboth
   $ hg debugsparse -X excluded
   $ cp ../dirstateboth .hg/dirstate
   $ hg debugrebuilddirstate
   $ hg debugdirstate
   n   0         -1 unset               included
 
 Test debugdirstate --minimal where file is in the parent manifest but not the
 dirstate
   $ hg debugsparse -X included
   $ hg debugdirstate
   $ cp .hg/dirstate ../dirstateallexcluded
   $ hg debugsparse --reset
   $ hg debugsparse -X excluded
   $ cp ../dirstateallexcluded .hg/dirstate
   $ touch includedadded
   $ hg add includedadded
   $ hg debugdirstate --nodates
   a   0         -1 unset               includedadded
   $ hg debugrebuilddirstate --minimal
   $ hg debugdirstate --nodates
   n   0         -1 unset               included
   a   0         -1 * includedadded (glob)
 
 Test debugdirstate --minimal where a file is not in parent manifest
 but in the dirstate. This should take into account excluded files in the
 manifest
   $ cp ../dirstateboth .hg/dirstate
   $ touch includedadded
   $ hg add includedadded
   $ touch excludednomanifest
   $ hg add excludednomanifest
   $ cp .hg/dirstate ../moreexcluded
   $ hg forget excludednomanifest
   $ rm excludednomanifest
   $ hg debugsparse -X excludednomanifest
   $ cp ../moreexcluded .hg/dirstate
   $ hg manifest
   excluded
   included
 We have files in the dirstate that are included and excluded. Some are in the
 manifest and some are not.
   $ hg debugdirstate --nodates
   n 644          0 * excluded (glob)
   a   0         -1 * excludednomanifest (glob)
   n 644          0 * included (glob)
   a   0         -1 * includedadded (glob)
   $ hg debugrebuilddirstate --minimal
   $ hg debugdirstate --nodates
   n 644          0 * included (glob)
   a   0         -1 * includedadded (glob)