Skip to content

scalar: add --<verb>-cache-server-url options #849

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
derrickstolee wants to merge 2 commits into
base: vfs-2.53.0
Choose a base branch
from
Open

scalar: add --<verb>-cache-server-url options #849

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
63f25a0
scalar: add --<verb>-cache-server-url options
derrickstolee Jan 23, 2026
25385e8
t9210: differentiate origin and cache servers
derrickstolee Jan 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions Documentation/scalar.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ SYNOPSIS
[verse]
scalar clone [--single-branch] [--branch <main-branch>] [--full-clone]
[--[no-]src] [--[no-]tags] [--[no-]maintenance]
[--[no-]src] [--local-cache-path <path>] [--cache-server-url <url>]
<url> [<enlistment>]
[--cache-server-url <url>] [--[verb]-cache-server-url <url>]
[--local-cache-path <path>] <url> [<enlistment>]
scalar list
scalar register [--[no-]maintenance] [<enlistment>]
scalar unregister [<enlistment>]
Expand Down Expand Up @@ -121,6 +121,11 @@ clone), and `~/.scalarCache` on macOS.
Retrieve missing objects from the specified remote, which is expected to
understand the GVFS protocol.

--[verb]-cache-server-url <url>::
Set the appropriate `gvfs.<verb>.cache-server` config value that overrides
the provided `--cache-server-url` or the dynamically discovered URL. The
list of allowed verbs is `prefetch`, `get`, and `post`.

--gvfs-protocol::
--no-gvfs-protocol::
When cloning from a `<url>` with either `dev.azure.com` or
Expand Down
40 changes: 39 additions & 1 deletion scalar.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -783,6 +783,7 @@ static int cmd_clone(int argc, const char **argv)
int src = 1, tags = 1, maintenance = 1;
const char *cache_server_url = NULL, *local_cache_root = NULL;
char *default_cache_server_url = NULL, *local_cache_root_abs = NULL;
const char *prefetch_server = NULL, *get_server = NULL, *post_server = NULL;
int gvfs_protocol = -1;
const char *ref_format = NULL;

Expand All @@ -805,6 +806,15 @@ static int cmd_clone(int argc, const char **argv)
OPT_STRING(0, "cache-server-url", &cache_server_url,
N_("<url>"),
N_("the url or friendly name of the cache server")),
OPT_STRING(0, "prefetch-cache-server-url", &prefetch_server,
N_("<url>"),
N_("the url or friendly name of a cache server for the prefetch endpoint")),
OPT_STRING(0, "get-cache-server-url", &get_server,
N_("<url>"),
N_("the url or friendly name of a cache server for the objects GET endpoint")),
OPT_STRING(0, "post-cache-server-url", &post_server,
N_("<url>"),
N_("the url or friendly name of a cache server for the objects POST endpoint")),
OPT_STRING(0, "local-cache-path", &local_cache_root,
N_("<path>"),
N_("override the path for the local Scalar cache")),
Expand All @@ -817,7 +827,8 @@ static int cmd_clone(int argc, const char **argv)
const char * const clone_usage[] = {
N_("scalar clone [--single-branch] [--branch <main-branch>] [--full-clone]\n"
"\t[--[no-]src] [--[no-]tags] [--[no-]maintenance] [--ref-format <format>]\n"
"\t<url> [<enlistment>]"),
"\t[--cache-server-url <url>] [--[verb]-cache-server-url <url>]\n"
"\t[--local-cache-path <path>] <url> [<enlistment>]"),
NULL
};
const char *url;
Expand Down Expand Up @@ -979,6 +990,33 @@ static int cmd_clone(int argc, const char **argv)
if (cache_server_url)
fprintf(stderr, "Cache server URL: %s\n",
cache_server_url);

if (prefetch_server &&
set_config("gvfs.prefetch.cache-server=%s", prefetch_server)) {
res = error(_("could not configure prefetch cache server"));
goto cleanup;
}
if (prefetch_server)
fprintf(stderr, "Prefetch cache server URL: %s\n",
prefetch_server);

if (get_server &&
set_config("gvfs.get.cache-server=%s", get_server)) {
res = error(_("could not configure objects GET cache server"));
goto cleanup;
}
if (get_server)
fprintf(stderr, "Objects GET cache server URL: %s\n",
get_server);

if (post_server &&
set_config("gvfs.post.cache-server=%s", post_server)) {
res = error(_("could not configure objects POST cache server"));
goto cleanup;
}
if (post_server)
fprintf(stderr, "Objects POST cache server URL: %s\n",
post_server);
} else {
if (set_config("core.useGVFSHelper=false") ||
set_config("remote.origin.promisor=true") ||
Expand Down
30 changes: 15 additions & 15 deletions t/lib-gvfs-helper.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ SHARED_CACHE_T2="$(pwd)"/shared_cache_t2
# The server will shut down if/when we delete it. (This is a little
# easier than killing it by PID.)
#
PID_FILE="$(pwd)"/pid-file.pid
SERVER_LOG="$(pwd)"/OUT.server.log
PID_FILE="$(pwd)"/pid-file-gvfs.pid
SERVER_LOG="$(pwd)"/OUT.gvfs.server.log

# Helper functions to compute port, pid-file, and log for a given
# port increment. An increment of 0 (or empty) uses the base values.
Expand All @@ -82,19 +82,19 @@ server_pid_file () {
}

server_log_file () {
local instance="${1:-0}"
local instance="${1:-1}"
if test "$instance" -eq 0
then
echo "$SERVER_LOG"
else
echo "$(pwd)/OUT.server-$instance.log"
echo "$(pwd)/OUT.gvfs.server-$instance.log"
fi
}

# Helper to build a cache-server URL for a given port increment.
#
cache_server_url () {
local instance="${1:-0}"
local instance="${1:-1}"
local port="$(server_port "$instance")"
echo "http://127.0.0.1:$port/servertype/cache"
}
Expand Down Expand Up @@ -277,7 +277,7 @@ test_expect_success 'setup repos' '
# Increment 0 uses the base port, 1 uses base+1, etc.
#
stop_gvfs_protocol_server () {
local instance="${1:-0}"
local instance="${1:-1}"
local pid_file="$(server_pid_file "$instance")"
local log_file="$(server_log_file "$instance")"

Expand All @@ -294,7 +294,7 @@ stop_gvfs_protocol_server () {
# port before the next test start another instance and it attempts to
# bind to it).
#
for k in 0 1 2 3 4
for k in $(test_seq 5)
do
if grep -q "Starting graceful shutdown" "$log_file"
then
Expand All @@ -315,7 +315,7 @@ stop_gvfs_protocol_server () {
# This allows running multiple servers simultaneously on different ports.
#
start_gvfs_protocol_server () {
local instance="${1:-0}"
local instance="${1:-1}"
local port="$(server_port "$instance")"
local pid_file="$(server_pid_file "$instance")"
local log_file="$(server_log_file "$instance")"
Expand All @@ -334,7 +334,7 @@ start_gvfs_protocol_server () {
#
# Give it a few seconds to get started.
#
for k in 0 1 2 3 4
for k in $(test_seq 5)
do
if test -f "$pid_file"
then
Expand Down Expand Up @@ -375,7 +375,7 @@ start_gvfs_protocol_server_with_mayhem () {
#
# Give it a few seconds to get started.
#
for k in 0 1 2 3 4
for k in $(test_seq 5)
do
if test -f "$PID_FILE"
then
Expand All @@ -392,7 +392,7 @@ start_gvfs_protocol_server_with_mayhem () {
# Usage: verify_server_was_contacted [<port_increment>]
#
verify_server_was_contacted () {
local instance="${1:-0}"
local instance="${1:-1}"
local log_file="$(server_log_file "$instance")"
grep -q "Connection from" "$log_file"
}
Expand All @@ -401,7 +401,7 @@ verify_server_was_contacted () {
# Usage: verify_server_was_not_contacted [<port_increment>]
#
verify_server_was_not_contacted () {
local instance="${1:-0}"
local instance="${1:-1}"
local log_file="$(server_log_file "$instance")"
! grep -q "Connection from" "$log_file"
}
Expand Down Expand Up @@ -529,9 +529,9 @@ verify_vfs_packfile_count () {
}

per_test_cleanup () {
# Stop servers with port increments 0, 1, 2, 3 to handle tests
# Stop servers with port increments 1, 2, 3, 4 to handle tests
# that may use multiple servers.
for instance in 0 1 2 3
for instance in 1 2 3 4
do
stop_gvfs_protocol_server "$instance"
done
Expand All @@ -540,7 +540,7 @@ per_test_cleanup () {
rm -rf "$SHARED_CACHE_T1"/info/*
rm -rf "$SHARED_CACHE_T1"/pack/*

rm -rf OUT.*
rm -rf OUT.gvfs.*
return 0
}

Expand Down
50 changes: 25 additions & 25 deletions t/t5795-gvfs-helper-verb-cache.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,32 +22,32 @@ test_description='gvfs-helper verb-specific cache-server tests'
test_expect_success 'verb-specific cache-server: prefetch uses gvfs.prefetch.cache-server' '
test_when_finished "per_test_cleanup" &&
test_when_finished "git -C \"$REPO_T1\" config --unset gvfs.prefetch.cache-server" &&
start_gvfs_protocol_server 0 &&
start_gvfs_protocol_server 1 &&
start_gvfs_protocol_server 2 &&

# Configure server 0 as default cache-server and server 1 for prefetch.
git -C "$REPO_T1" config gvfs.cache-server "$(cache_server_url 0)" &&
git -C "$REPO_T1" config gvfs.prefetch.cache-server "$(cache_server_url 1)" &&

# Run prefetch - should go to server 1.
# Run prefetch - should go to server 2.
git -C "$REPO_T1" gvfs-helper \
--cache-server=trust \
--remote=origin \
--no-progress \
prefetch >OUT.output 2>OUT.stderr &&

# Verify server 1 was contacted (prefetch-specific).
verify_server_was_contacted 1 &&
verify_server_was_contacted 2 &&

# Verify server 0 was NOT contacted.
verify_server_was_not_contacted 0
verify_server_was_not_contacted 1
'

test_expect_success 'verb-specific cache-server: get does NOT use gvfs.prefetch.cache-server' '
test_when_finished "per_test_cleanup" &&
test_when_finished "git -C \"$REPO_T1\" config --unset gvfs.prefetch.cache-server" &&
start_gvfs_protocol_server 0 &&
start_gvfs_protocol_server 1 &&
start_gvfs_protocol_server 2 &&

# Configure server 0 as default cache-server and server 1 for prefetch.
git -C "$REPO_T1" config gvfs.cache-server "$(cache_server_url 0)" &&
Expand All @@ -61,41 +61,41 @@ test_expect_success 'verb-specific cache-server: get does NOT use gvfs.prefetch.
<"$OID_ONE_BLOB_FILE" >OUT.output 2>OUT.stderr &&

# Verify server 0 was contacted (default cache-server).
verify_server_was_contacted 0 &&
verify_server_was_contacted 1 &&

# Verify server 1 was NOT contacted (prefetch-specific).
verify_server_was_not_contacted 1
verify_server_was_not_contacted 2
'

test_expect_success 'verb-specific cache-server: get uses gvfs.get.cache-server' '
test_when_finished "per_test_cleanup" &&
test_when_finished "git -C \"$REPO_T1\" config --unset gvfs.get.cache-server" &&
start_gvfs_protocol_server 0 &&
start_gvfs_protocol_server 1 &&
start_gvfs_protocol_server 2 &&

# Configure server 0 as default cache-server and server 1 for get.
git -C "$REPO_T1" config gvfs.cache-server "$(cache_server_url 0)" &&
git -C "$REPO_T1" config gvfs.get.cache-server "$(cache_server_url 1)" &&

# Run get - should go to server 1.
# Run get - should go to server 2.
git -C "$REPO_T1" gvfs-helper \
--cache-server=trust \
--remote=origin \
get \
<"$OID_ONE_BLOB_FILE" >OUT.output 2>OUT.stderr &&

# Verify server 1 was contacted (get-specific).
verify_server_was_contacted 1 &&
verify_server_was_contacted 2 &&

# Verify server 0 was NOT contacted.
verify_server_was_not_contacted 0
verify_server_was_not_contacted 1
'

test_expect_success 'verb-specific cache-server: prefetch does NOT use gvfs.get.cache-server' '
test_when_finished "per_test_cleanup" &&
test_when_finished "git -C \"$REPO_T1\" config --unset gvfs.get.cache-server" &&
start_gvfs_protocol_server 0 &&
start_gvfs_protocol_server 1 &&
start_gvfs_protocol_server 2 &&

# Configure server 0 as default cache-server and server 1 for get.
git -C "$REPO_T1" config gvfs.cache-server "$(cache_server_url 0)" &&
Expand All @@ -109,23 +109,23 @@ test_expect_success 'verb-specific cache-server: prefetch does NOT use gvfs.get.
prefetch >OUT.output 2>OUT.stderr &&

# Verify server 0 was contacted (default cache-server).
verify_server_was_contacted 0 &&
verify_server_was_contacted 1 &&

# Verify server 1 was NOT contacted (get-specific).
verify_server_was_not_contacted 1
verify_server_was_not_contacted 2
'

test_expect_success 'verb-specific cache-server: post uses gvfs.post.cache-server' '
test_when_finished "per_test_cleanup" &&
test_when_finished "git -C \"$REPO_T1\" config --unset gvfs.post.cache-server" &&
start_gvfs_protocol_server 0 &&
start_gvfs_protocol_server 1 &&
start_gvfs_protocol_server 2 &&

# Configure server 0 as default cache-server and server 1 for post.
git -C "$REPO_T1" config gvfs.cache-server "$(cache_server_url 0)" &&
git -C "$REPO_T1" config gvfs.post.cache-server "$(cache_server_url 1)" &&

# Run post - should go to server 1.
# Run post - should go to server 2.
git -C "$REPO_T1" gvfs-helper \
--cache-server=trust \
--remote=origin \
Expand All @@ -134,17 +134,17 @@ test_expect_success 'verb-specific cache-server: post uses gvfs.post.cache-serve
<"$OIDS_BLOBS_FILE" >OUT.output 2>OUT.stderr &&

# Verify server 1 was contacted (post-specific).
verify_server_was_contacted 1 &&
verify_server_was_contacted 2 &&

# Verify server 0 was NOT contacted.
verify_server_was_not_contacted 0
verify_server_was_not_contacted 1
'

test_expect_success 'verb-specific cache-server: get does NOT use gvfs.post.cache-server' '
test_when_finished "per_test_cleanup" &&
test_when_finished "git -C \"$REPO_T1\" config --unset gvfs.post.cache-server" &&
start_gvfs_protocol_server 0 &&
start_gvfs_protocol_server 1 &&
start_gvfs_protocol_server 2 &&

# Configure server 0 as default cache-server and server 1 for post.
git -C "$REPO_T1" config gvfs.cache-server "$(cache_server_url 0)" &&
Expand All @@ -158,10 +158,10 @@ test_expect_success 'verb-specific cache-server: get does NOT use gvfs.post.cach
<"$OID_ONE_BLOB_FILE" >OUT.output 2>OUT.stderr &&

# Verify server 0 was contacted (default cache-server).
verify_server_was_contacted 0 &&
verify_server_was_contacted 1 &&

# Verify server 1 was NOT contacted (post-specific).
verify_server_was_not_contacted 1
verify_server_was_not_contacted 2
'

test_expect_success 'verb-specific cache-server: all verbs with different servers' '
Expand All @@ -170,9 +170,9 @@ test_expect_success 'verb-specific cache-server: all verbs with different server
test_when_finished "git -C \"$REPO_T1\" config --unset gvfs.prefetch.cache-server" &&
test_when_finished "git -C \"$REPO_T1\" config --unset gvfs.get.cache-server" &&
test_when_finished "git -C \"$REPO_T1\" config --unset gvfs.post.cache-server" &&
start_gvfs_protocol_server 0 &&
start_gvfs_protocol_server 1 &&
start_gvfs_protocol_server 2 &&
start_gvfs_protocol_server 2 &&
start_gvfs_protocol_server 3 &&

# Configure each verb to use a different server:
Expand All @@ -185,14 +185,14 @@ test_expect_success 'verb-specific cache-server: all verbs with different server
git -C "$REPO_T1" config gvfs.get.cache-server "$(cache_server_url 2)" &&
git -C "$REPO_T1" config gvfs.post.cache-server "$(cache_server_url 3)" &&

# Run prefetch - should go to server 1.
# Run prefetch - should go to server 2.
git -C "$REPO_T1" gvfs-helper \
--cache-server=trust \
--remote=origin \
--no-progress \
prefetch >OUT.output 2>OUT.stderr &&
verify_server_was_contacted 1 &&
verify_server_was_not_contacted 0 &&
verify_server_was_contacted 2 &&
verify_server_was_not_contacted 1 &&
verify_server_was_not_contacted 2 &&
verify_server_was_not_contacted 3 &&

Expand Down
Loading
Loading