git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [Outreachy PATCH] credential-store: add lockTimeout config option

From
Junio C Hamano <gitster@pobox.com>
Date
Oct 15, 2026, 17:50 UTC
Message-ID
<xmqqcxtaonu2.fsf@gitster.g>
In-Reply-To
<20261014232739.23021-1-okhuomonajayi54@gmail.com>
Okhuomon Ajayi <okhuomonajayi54@gmail.com> writes:
Show 14 quoted lines
> diff --git a/builtin/credential-store.c b/builtin/credential-store.c
> index bc1453c6b2..9fef54d218 100644
> --- a/builtin/credential-store.c
> +++ b/builtin/credential-store.c
> @@ -67,7 +67,9 @@ static void rewrite_credential_file(const char *fn, struct credential *c,
>  {
>  	int timeout_ms = 1000;
>  
> -	repo_config_get_int(the_repository, "credentialstore.locktimeoutms", &timeout_ms);
> +	/* lockTimeoutMS is a deprecated synonym of lockTimeout. */
> +	if (repo_config_get_int(the_repository, "credentialstore.locktimeout", &timeout_ms))
> +		repo_config_get_int(the_repository, "credentialstore.locktimeoutms", &timeout_ms);
>  	if (hold_lock_file_for_update_timeout(&credential_lock, fn, 0, timeout_ms) < 0)
>  		die_errno(_("unable to get credential storage lock in %d ms"), timeout_ms);

Around this point the file is already full of overly long lines, but the patch is making it even worse.

Show 35 quoted lines
> diff --git a/t/t0302-credential-store.sh b/t/t0302-credential-store.sh
> index c1cd60edd0..408f26bb10 100755
> --- a/t/t0302-credential-store.sh
> +++ b/t/t0302-credential-store.sh
> @@ -210,4 +210,60 @@ test_expect_success 'get: store file can contain empty/bogus lines' '
>  	EOF
>  '
>  
> +# Holding creds.lock makes the next store fail. The error reports the
> +# timeout that was actually used, so "in 0 ms" means that name won.
> +test_expect_success 'credentialStore.lockTimeoutMS=0 gives up immediately' '
> +	test_when_finished "rm -f creds creds.lock" &&
> +	>"creds.lock" &&
> +	test_must_fail git -c credentialStore.lockTimeoutMS=0 \
> +		credential-store --file=creds store 2>err <<-\EOF &&
> +	protocol=https
> +	host=example.com
> +	username=store-user
> +	password=store-pass
> +	EOF
> +	test_grep "unable to get credential storage lock in 0 ms" err
> +'
> +
> +test_expect_success 'credentialStore.lockTimeout=0 gives up immediately' '
> +	test_when_finished "rm -f creds creds.lock" &&
> +	>"creds.lock" &&
> +	test_must_fail git -c credentialStore.lockTimeout=0 \
> +		credential-store --file=creds store 2>err <<-\EOF &&
> +	protocol=https
> +	host=example.com
> +	username=store-user
> +	password=store-pass
> +	EOF
> +	test_grep "unable to get credential storage lock in 0 ms" err
> +'

As it is necessary to keep the above two in sync forever, it may make sense to do this instead:

	for v lockTimeout lockTimeoutMS
	do
		test_expect_success "credentialStore.$v=0 gives up immediately" '
			...
			test_must_fail git -c credentialStore.$v=0 \
			credential-store --file=creds store 2>err <<-\EOF &&
			...
			test_grep "unable to get ..." err
		'
	done

It is a common mistake to use double-quote in an attempt to have $v expanded before it is passed to text_expect_success function, but the variable $v is dereferenced correctly inside the body of the test that is quoted with single-quote as it is eval'ed, so the way the above is written is right.

Show 14 quoted lines
> +test_expect_success 'credentialStore.lockTimeout wins when both are set' '
> +	test_when_finished "rm -f creds creds.lock" &&
> +	>"creds.lock" &&
> +	test_must_fail git \
> +		-c credentialStore.lockTimeout=0 \
> +		-c credentialStore.lockTimeoutMS=500 \
> +		credential-store --file=creds store 2>err <<-\EOF &&
> +	protocol=https
> +	host=example.com
> +	username=store-user
> +	password=store-pass
> +	EOF
> +	test_grep "unable to get credential storage lock in 0 ms" err
> +'

This is understandable. The presense of locktimeout=0 hides whatever locktimeoutms is set to, so it should fail the same way as the earlier two tests. Wait, nobody unlocks creds.lock, so what should happen if the line that sets locktimeout=0 is removed?

Ahh, the key to this test is that we make sure "in 0 ms" part of the error message does not say "in 500 ms" to ensure which of the two variables are being used. It is not like the credential-store command would fail with 0ms timeout but succees with 500ms timeout.

Show 12 quoted lines
> +test_expect_success 'credentialStore.lockTimeout allows a store' '
> +	test_when_finished "rm -f creds" &&
> +	git -c credentialStore.lockTimeout=1000 \
> +		credential-store --file=creds store <<-\EOF &&
> +	protocol=https
> +	host=example.com
> +	username=store-user
> +	password=store-pass
> +	EOF
> +	echo "https://store-user:store-pass@example.com" >expect &&
> +	test_cmp expect creds
> +'

This one I I am not sure what it is trying to test, though. Would the test start failing as the machine is loaded more and 1000 ms becomes insufficient? No. The thing is not locked, nobody takes a lock competing with our test, so with any value of the timeout we should succeed, no? Or would it fail if the timeout is set to 0ms?

Assuming that there is a reason to run this test, should it also be testing locktimeoutms to ensure both variables behave the same way when set independently, similarly to the two tests I rewrote into a for loop?

Thanks.
Previous: Okhuomon AjayiNext: Okhuomon Ajayi
Message 49 of 66 in “rerere: keep a background gc from killing a rebase”
  1. rerere: keep a background gc from killing a rebaseThomas Bachem via GitGitGadget, Sep 2, 2026
  2. Phillip WoodSep 2, 2026
  3. Thomas BachemSep 2, 2026
  4. Phillip WoodSep 3, 2026
  5. Patrick SteinhardtSep 3, 2026
  6. Thomas BachemSep 3, 2026
  7. Patrick SteinhardtSep 3, 2026
  8. Thomas BachemSep 3, 2026
  9. Phillip WoodSep 3, 2026
  10. rerere: keep a background gc from killing a rebaseThomas Bachem via GitGitGadget, Sep 4, 2026
  11. Phillip WoodSep 4, 2026
  12. Thomas BachemSep 4, 2026
  13. Phillip WoodSep 7, 2026
  14. Junio C HamanoSep 4, 2026
  15. Thomas BachemSep 4, 2026
  16. rerere: keep a background gc from killing a rebaseThomas Bachem via GitGitGadget, Sep 4, 2026
  17. Junio C HamanoSep 4, 2026
  18. Thomas BachemSep 5, 2026
  19. Junio C HamanoSep 5, 2026
  20. Thomas BachemSep 6, 2026
  21. Patrick SteinhardtSep 7, 2026
  22. 0/2 rerere: wait for MERGE_RR.lock, and go on at a conflictThomas Bachem via GitGitGadget, Sep 14, 2026
  23. 1/2 rerere: wait for MERGE_RR.lock, and let the gc skip itThomas Bachem via GitGitGadget, Sep 14, 2026
  24. Patrick SteinhardtSep 28, 2026
  25. 2/2 rerere: go on at a conflict when the lock stays busyThomas Bachem via GitGitGadget, Sep 14, 2026
  26. Patrick SteinhardtSep 28, 2026
  27. 0/3 rerere: wait for MERGE_RR.lock, and go on at a conflictThomas Bachem via GitGitGadget, Sep 28, 2026
  28. 1/3 rerere: wait for MERGE_RR.lock before giving upThomas Bachem via GitGitGadget, Sep 28, 2026
  29. 2/3 rerere: add "gc --auto" that skips a held lockThomas Bachem via GitGitGadget, Sep 28, 2026
  30. Patrick SteinhardtSep 30, 2026
  31. Thomas BachemOct 1, 2026
  32. Patrick SteinhardtOct 1, 2026
  33. 3/3 rerere: go on at a conflict when the lock stays busyThomas Bachem via GitGitGadget, Sep 28, 2026
  34. 0/3 rerere: wait for MERGE_RR.lock, and go on at a conflictThomas Bachem via GitGitGadget, Oct 2, 2026
  35. 1/3 rerere: wait for MERGE_RR.lock before giving upThomas Bachem via GitGitGadget, Oct 2, 2026
  36. 2/3 rerere: add "gc --skip-locked" for auto maintenanceThomas Bachem via GitGitGadget, Oct 2, 2026
  37. Patrick SteinhardtOct 9, 2026
  38. Thomas BachemOct 10, 2026
  39. 3/3 rerere: go on at a conflict when the lock stays busyThomas Bachem via GitGitGadget, Oct 2, 2026
  40. Patrick SteinhardtOct 9, 2026
  41. Thomas BachemOct 10, 2026
  42. 0/2 rerere: wait for MERGE_RR.lock, but not in auto maintenanceThomas Bachem via GitGitGadget, Oct 10, 2026
  43. 1/2 rerere: wait for MERGE_RR.lock before giving upThomas Bachem via GitGitGadget, Oct 10, 2026
  44. Junio C HamanoOct 11, 2026
  45. Thomas BachemOct 11, 2026
  46. Junio C HamanoOct 12, 2026
  47. Okhuomon AjayiOct 14, 2026
  48. credential-store: add lockTimeout config optionOkhuomon Ajayi, Oct 14, 2026
  49. Junio C HamanoOct 15, 2026
  50. Okhuomon AjayiOct 16, 2026
  51. credential-store: add lockTimeout config optionOkhuomon Ajayi, Oct 16, 2026
  52. Okhuomon AjayiOct 20, 2026
  53. Okhuomon AjayiNov 12, 2026
  54. Junio C HamanoNov 12, 2026
  55. Okhuomon AjayiNov 15, 2026
  56. credential-store: add lockTimeout config optionOkhuomon Ajayi, Nov 16, 2026
  57. Junio C HamanoNov 16, 2026
  58. 2/2 rerere: add "gc --skip-locked" for auto maintenanceThomas Bachem via GitGitGadget, Oct 10, 2026
  59. Patrick SteinhardtOct 13, 2026
  60. 0/2 rerere: wait for MERGE_RR.lock, but not in auto maintenanceThomas Bachem via GitGitGadget, Oct 13, 2026
  61. 1/2 rerere: wait for MERGE_RR.lock before giving upThomas Bachem via GitGitGadget, Oct 13, 2026
  62. 2/2 rerere: add "gc --skip-locked" for auto maintenanceThomas Bachem via GitGitGadget, Oct 13, 2026
  63. Patrick SteinhardtOct 13, 2026
  64. Junio C HamanoOct 13, 2026
  65. Patrick SteinhardtOct 14, 2026
  66. Thomas BachemOct 14, 2026

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.