Subject: [PATCH v2 0/3] sparse-index: expand/collapse based on 'index.sparse'

From: "Victoria Dye via GitGitGadget" <[email-masked]>
Date: Thu, 21 Oct 2021 20:48:23 +0000

This series updates do_read_index to use the index.sparse config setting
when determining whether the index should be expanded or collapsed. If the
command & repo allow use of a sparse index, index.sparse is enabled, and a
full index is read from disk, the index is collapsed before returning to the
caller. Conversely, if index.sparse is disabled but the index read from disk
is sparse, the index is expanded before returning. This allows index.sparse
to control use of the sparse index in addition to its existing control over
how the index is written to disk. It also introduces the ability to
enable/disable the sparse index on a command-by-command basis (e.g.,
allowing a user to troubleshoot a sparse-aware command with '-c
index.sparse=false' [1]).

While testing this change, a bug was found in 'test-tool read-cache' in
which config settings for the repository were not initialized before
preparing the repo settings. This caused index.sparse to always be 'false'
when using the test helper in a cone-mode sparse checkout, breaking tests in
t1091 and t1092. The issue is fixed by moving prepare_repo_settings after
config setup.

Changes since V1
================

 * Add ensure_correct_sparsity function that ensures the index is sparse if
   the repository settings (including index.sparse) allow it, otherwise
   ensuring the index is expanded to full.
 * Restructure condition in do_read_index to, rather than check specifically
   for the index.sparse config setting, call ensure_correct_sparsity
   unconditionally when command_requires_full_index is false.

[1]
https://lore.kernel.org/git/[email-masked]/

Thanks! -Victoria

Victoria Dye (3):
  test-read-cache.c: prepare_repo_settings after config init
  sparse-index: add ensure_correct_sparsity function
  sparse-index: update do_read_index to ensure correct sparsity

 read-cache.c                             |  8 +++++
 sparse-index.c                           | 42 ++++++++++++++++++++++--
 sparse-index.h                           |  2 ++
 t/helper/test-read-cache.c               |  5 +--
 t/t1092-sparse-checkout-compatibility.sh | 31 +++++++++++++++++
 5 files changed, 83 insertions(+), 5 deletions(-)

base-commit: f443b226ca681d87a3a31e245a70e6bc2769123c
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1059%2Fvdye%2Fsparse%2Findex-sparse-config-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1059/vdye/sparse/index-sparse-config-v2
Pull-Request: https://github.com/gitgitgadget/git/pull/1059

Range-diff vs v1:

 1:  6974ce7e7f5 = 1:  6974ce7e7f5 test-read-cache.c: prepare_repo_settings after config init
 -:  ----------- > 2:  0b6e6633bb2 sparse-index: add ensure_correct_sparsity function
 2:  c6279b22545 ! 3:  437cf398256 sparse-index: update index read to consider index.sparse config
     @@ Metadata
      Author: Victoria Dye <[email-masked]>
      
       ## Commit message ##
     -    sparse-index: update index read to consider index.sparse config
     +    sparse-index: update do_read_index to ensure correct sparsity
      
     -    Use the index.sparse config setting to expand or collapse the index when
     -    read. Previously, index.sparse would determine how the index would be
     -    written to disk, but would not enforce whether the index is read into memory
     -    as full or sparse. Now, the index is expanded when a sparse index is read
     -    with `index.sparse=false` and is collapsed to sparse when a full index is
     -    read with `index.sparse=true` (and the command does not require a full
     -    index).
     +    If `command_requires_full_index` is false, ensure correct in-core index
     +    sparsity on read by calling `ensure_correct_sparsity`. This change is meant
     +    to update the how the index is read in a command after sparse index-related
     +    repository settings are modified. Previously, for example, if `index.sparse`
     +    were changed from `true` to `false`, the in-core index on the next command
     +    would be sparse. The index would only be expanded to full when it was next
     +    written to disk.
      
     -    This makes the behavior of `index.sparse` more intuitive, as it now clearly
     -    enables/disables usage of a sparse index. It also provides users with a way
     -    to disable the sparse index per-command (e.g., for troubleshooting purposes)
     -    without needing to re-initialize the sparse-checkout.
     +    By adding a call to `ensure_correct_sparsity`, the in-core index now matches
     +    the sparsity dictated by the relevant repository settings as soon as it is
     +    read into memory, rather than when it is later written to disk.
      
     +    Helped-by: Junio C Hamano <[email-masked]>
          Co-authored-by: Derrick Stolee <[email-masked]>
          Signed-off-by: Victoria Dye <[email-masked]>
      
       ## read-cache.c ##
      @@ read-cache.c: int do_read_index(struct index_state *istate, const char *path, int must_exist)
     + 
       	if (!istate->repo)
       		istate->repo = the_repository;
     ++
     ++	/*
     ++	 * If the command explicitly requires a full index, force it
     ++	 * to be full. Otherwise, correct the sparsity based on repository
     ++	 * settings and other properties of the index (if necessary).
     ++	 */
       	prepare_repo_settings(istate->repo);
     --	if (istate->repo->settings.command_requires_full_index)
     -+	if (!istate->repo->settings.sparse_index ||
     -+	    istate->repo->settings.command_requires_full_index)
     + 	if (istate->repo->settings.command_requires_full_index)
       		ensure_full_index(istate);
     -+	else if (!istate->sparse_index)
     -+		convert_to_sparse(istate, 0);
     ++	else
     ++		ensure_correct_sparsity(istate);
       
       	return istate->cache_nr;

-- 
gitgitgadget