Subject: [PATCH v2] repo-settings: fix checking for fetch.negotiationAlgorithm=default

From: "Elijah Newren via GitGitGadget" <[email-masked]>
Date: Sat, 29 Jan 2022 17:51:32 +0000

From: Elijah Newren <[email-masked]>

In commit 3050b6dfc75d (repo-settings.c: simplify the setup,
2021-09-21), the branch for handling fetch.negotiationAlgorithm=default
was deleted.  Since this value is documented in
Documentation/config/fetch.txt, restore the check for this value.

Note that this change caused an observable bug: if someone sets
feature.experimental=true in config, and then passes "-c
fetch.negotiationAlgorithm=default" on the command line in an attempt to
override the config, then the override is ignored.  Fix the bug by not
ignoring the value of "default".

Technically, before commit 3050b6dfc75d, repo-settings would treat any
fetch.negotiationAlgorithm value other than "skipping" or "noop" as a
request for "default", but I think it probably makes more sense to
ignore such broken requests and leave fetch.negotiationAlgorithm with
the default value rather than the value of "default".  (If that sounds
confusing, note that "default" is usually the default value, but when
feature.experimental=true, "skipping" is the default value.)

Signed-off-by: Elijah Newren <[email-masked]>
---
    repo-settings: fix checking for fetch.negotiationAlgorithm=default
    
    This regression is not new in v2.35; it first appeared in v2.34. So, not
    urgent.
    
    Changes since v1:
    
     * Put the common code in two testcases into a function, and then just
       invoked it from each

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1131%2Fnewren%2Ffix-fetch-negotiation-algorithm-equals-default-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1131/newren/fix-fetch-negotiation-algorithm-equals-default-v2
Pull-Request: https://github.com/gitgitgadget/git/pull/1131

Range-diff vs v1:

 1:  9c592baded1 ! 1:  633c873b513 repo-settings: fix checking for fetch.negotiationAlgorithm=default
     @@ repo-settings.c: void prepare_repo_settings(struct repository *r)
      
       ## t/t5500-fetch-pack.sh ##
      @@ t/t5500-fetch-pack.sh: test_expect_success 'fetching deepen' '
     + 	)
       '
       
     - test_expect_success 'use ref advertisement to prune "have" lines sent' '
     +-test_expect_success 'use ref advertisement to prune "have" lines sent' '
     ++test_negotiation_algorithm_default () {
      +	test_when_finished rm -rf clientv0 clientv2 &&
       	rm -rf server client &&
       	git init server &&
       	test_commit -C server both_have_1 &&
      @@ t/t5500-fetch-pack.sh: test_expect_success 'use ref advertisement to prune "have" lines sent' '
     + 	rm -f trace &&
     + 	cp -r client clientv0 &&
     + 	GIT_TRACE_PACKET="$(pwd)/trace" git -C clientv0 \
     +-		fetch origin server_has both_have_2 &&
     ++		"$@" fetch origin server_has both_have_2 &&
     + 	grep "have $(git -C client rev-parse client_has)" trace &&
     + 	grep "have $(git -C client rev-parse both_have_2)" trace &&
     + 	! grep "have $(git -C client rev-parse both_have_2^)" trace &&
     +@@ t/t5500-fetch-pack.sh: test_expect_success 'use ref advertisement to prune "have" lines sent' '
     + 	rm -f trace &&
     + 	cp -r client clientv2 &&
     + 	GIT_TRACE_PACKET="$(pwd)/trace" git -C clientv2 -c protocol.version=2 \
     +-		fetch origin server_has both_have_2 &&
     ++		"$@" fetch origin server_has both_have_2 &&
     + 	grep "have $(git -C client rev-parse client_has)" trace &&
     + 	grep "have $(git -C client rev-parse both_have_2)" trace &&
       	! grep "have $(git -C client rev-parse both_have_2^)" trace
     - '
     - 
     -+test_expect_success 'same as last but with config overrides' '
     -+	test_when_finished rm -rf clientv0 clientv2 &&
     -+	rm -rf server client &&
     -+	git init server &&
     -+	test_commit -C server both_have_1 &&
     -+	git -C server tag -d both_have_1 &&
     -+	test_commit -C server both_have_2 &&
     -+
     -+	git clone server client &&
     -+	test_commit -C server server_has &&
     -+	test_commit -C client client_has &&
     ++}
      +
     -+	# In both protocol v0 and v2, ensure that the parent of both_have_2 is
     -+	# not sent as a "have" line. The client should know that the server has
     -+	# both_have_2, so it only needs to inform the server that it has
     -+	# both_have_2, and the server can infer the rest.
     -+
     -+	rm -f trace &&
     -+	rm -rf clientv0 &&
     -+	cp -r client clientv0 &&
     -+	GIT_TRACE_PACKET="$(pwd)/trace" git -C clientv0 \
     -+		-c feature.experimental=true \
     -+		-c fetch.negotiationAlgorithm=default \
     -+		fetch origin server_has both_have_2 &&
     -+	grep "have $(git -C client rev-parse client_has)" trace &&
     -+	grep "have $(git -C client rev-parse both_have_2)" trace &&
     -+	! grep "have $(git -C client rev-parse both_have_2^)" trace &&
     ++test_expect_success 'use ref advertisement to prune "have" lines sent' '
     ++	test_negotiation_algorithm_default
     ++'
      +
     -+	rm -f trace &&
     -+	cp -r client clientv2 &&
     -+	GIT_TRACE_PACKET="$(pwd)/trace" git -C clientv2 -c protocol.version=2 \
     ++test_expect_success 'same as last but with config overrides' '
     ++	test_negotiation_algorithm_default \
      +		-c feature.experimental=true \
      +		-c fetch.negotiationAlgorithm=default \
     -+		fetch origin server_has both_have_2 &&
     -+	grep "have $(git -C client rev-parse client_has)" trace &&
     -+	grep "have $(git -C client rev-parse both_have_2)" trace &&
     -+	! grep "have $(git -C client rev-parse both_have_2^)" trace
     -+'
     -+
     + '
     + 
       test_expect_success 'filtering by size' '
     - 	rm -rf server client &&
     - 	test_create_repo server &&

 repo-settings.c       |  2 ++
 t/t5500-fetch-pack.sh | 17 ++++++++++++++---
 2 files changed, 16 insertions(+), 3 deletions(-)

diff --git a/repo-settings.c b/repo-settings.c
index 00ca5571a1a..38c10f9977b 100644
--- a/repo-settings.c
+++ b/repo-settings.c
@@ -85,6 +85,8 @@ void prepare_repo_settings(struct repository *r)
 			r->settings.fetch_negotiation_algorithm = FETCH_NEGOTIATION_SKIPPING;
 		else if (!strcasecmp(strval, "noop"))
 			r->settings.fetch_negotiation_algorithm = FETCH_NEGOTIATION_NOOP;
+		else if (!strcasecmp(strval, "default"))
+			r->settings.fetch_negotiation_algorithm = FETCH_NEGOTIATION_DEFAULT;
 	}
 
 	/*
diff --git a/t/t5500-fetch-pack.sh b/t/t5500-fetch-pack.sh
index f0dc4e69686..0a737cf0a0a 100755
--- a/t/t5500-fetch-pack.sh
+++ b/t/t5500-fetch-pack.sh
@@ -927,7 +927,8 @@ test_expect_success 'fetching deepen' '
 	)
 '
 
-test_expect_success 'use ref advertisement to prune "have" lines sent' '
+test_negotiation_algorithm_default () {
+	test_when_finished rm -rf clientv0 clientv2 &&
 	rm -rf server client &&
 	git init server &&
 	test_commit -C server both_have_1 &&
@@ -946,7 +947,7 @@ test_expect_success 'use ref advertisement to prune "have" lines sent' '
 	rm -f trace &&
 	cp -r client clientv0 &&
 	GIT_TRACE_PACKET="$(pwd)/trace" git -C clientv0 \
-		fetch origin server_has both_have_2 &&
+		"$@" fetch origin server_has both_have_2 &&
 	grep "have $(git -C client rev-parse client_has)" trace &&
 	grep "have $(git -C client rev-parse both_have_2)" trace &&
 	! grep "have $(git -C client rev-parse both_have_2^)" trace &&
@@ -954,10 +955,20 @@ test_expect_success 'use ref advertisement to prune "have" lines sent' '
 	rm -f trace &&
 	cp -r client clientv2 &&
 	GIT_TRACE_PACKET="$(pwd)/trace" git -C clientv2 -c protocol.version=2 \
-		fetch origin server_has both_have_2 &&
+		"$@" fetch origin server_has both_have_2 &&
 	grep "have $(git -C client rev-parse client_has)" trace &&
 	grep "have $(git -C client rev-parse both_have_2)" trace &&
 	! grep "have $(git -C client rev-parse both_have_2^)" trace
+}
+
+test_expect_success 'use ref advertisement to prune "have" lines sent' '
+	test_negotiation_algorithm_default
+'
+
+test_expect_success 'same as last but with config overrides' '
+	test_negotiation_algorithm_default \
+		-c feature.experimental=true \
+		-c fetch.negotiationAlgorithm=default \
 '
 
 test_expect_success 'filtering by size' '

base-commit: 89bece5c8c96f0b962cfc89e63f82d603fd60bed
-- 
gitgitgadget