The "promisor-remote" capability can only be used to pass the names
and URLs of the promisor remotes from the server to the client. After
that the client can use this information to decide if it accepts the
remotes or not.
It would be nice if the server could pass more fields about its
remotes and if the client could use that additional information to
decide about the remotes by comparing it with its local information
about the remotes.
This patch series implements this by adding the "promisor.sendFields"
on the server side and the "promisor.checkFields" on the client side.
For example, if "promisor.sendFields" is set to "partialCloneFilter",
and the server has the remote "foo" configured like this:
[remote "foo"]
url = file:///tmp/foo.git
partialCloneFilter = blob:none
then "name=foo,url=file:///tmp/foo.git,partialCloneFilter=blob:none"
will be sent by the server for this remote.
All the information passed through the "promisor-remote" capability is
still only used to decide if the remotes are accepted or not. The
client doesn't store it and doesn't use it for any other purpose.
Note that the filter mechanism already exists for a long time and this
series doesn't change how it works. For example, it has already been
possible for a long time to have different repos using the same
promisor remote with different filters. See the existing partial clone
documentation (like "Documentation/technical/partial-clone.adoc") for
more information on partial clone.
The fields that can be passed are limited to "partialCloneFilter" and
"token".
On the technical side, we get rid of 'struct strvec' and we use
'struct promisor_info' to store the data and 'struct string_list' to
store the 'struct promisor_info' instances instead.
This work is part of the "LOP" effort documented in:
Documentation/technical/large-object-promisors.adoc
See that doc for more information on the broader context.
Changes since v4
----------------
Thanks to Patrick, Junio, Karthik and Justin for their comments on the
previous versions.
There are very few changes compared to v4 and they are quite small.
In patch 1/5, in the commit message:
- a few sentences were added to explain why using 'struct strvec'
for the new fields wouldn't scale well,
- a typo "use use" was fixed.
In patch 1/5, in the code, a BUG() message was improved.
In patch 2/5, in the code, some code comments were added in
fields_from_config().
CI tests
--------
They all passed:
https://github.com/chriscool/git/actions/runs/15846478103
Range diff compared to v4
-------------------------
1: 8a4df71d2c ! 1: 3700939f67 promisor-remote: refactor to get rid of 'struct strvec'
@@ Commit message
for different promisor remotes. Unfortunately using 'struct strvec',
as we currently do, to store information about the promisor remotes
with one 'struct strvec' for each field like "name" or "url" does not
- scale easily in that case.
+ scale easily in that case. We would need one 'struct strvec' for each
+ new field, and then we would have to pass all these 'struct strvec'
+ around.
Let's refactor this and introduce a new 'struct promisor_info'.
It will only store promisor remote information in its members. For now
it has only a 'name' member for the promisor remote name and an 'url'
- member for its URL. We will use use a 'struct string_list' to store
- the instances of 'struct promisor_info'. For each 'item' in the
+ member for its URL. We will use a 'struct string_list' to store the
+ instances of 'struct promisor_info'. For each 'item' in the
string_list, 'item->string' will point to the promisor remote name and
'item->util' will point to the corresponding 'struct promisor_info'
instance.
@@ promisor-remote.c: static int should_accept_remote(enum accept_promisor accept,
- if (!strcmp(urls->v[i], remote_url))
+ if (!p->url)
-+ BUG("bad config_info (invalid URL) for remote '%s'",
++ BUG("bad config_info (URL is NULL) for remote '%s'",
+ remote_name);
+
+ if (!strcmp(p->url, remote_url))
2: 8f3111b4f2 ! 2: f546756705 promisor-remote: allow a server to advertise more fields
@@ promisor-remote.c: static int allow_unsanitized(char ch)
+ char *fields = NULL;
+
+ if (!git_config_get_string(config_key, &fields) && *fields) {
++ /* Split on any comma or space character */
+ string_list_split_in_place(fields_list, fields, ", ", -1);
++ /*
++ * Remove empty items that might result from trailing
++ * commas, or from items being separated by both
++ * commas and spaces.
++ */
+ string_list_remove_empty_items(fields_list, 0);
+ filter_string_list(fields_list, 0, is_valid_field, (void *)config_key);
+ }
3: c91a1ba04a = 3: 3ac73b14eb promisor-remote: refactor how we parse advertised fields
4: ad68202057 = 4: b75577eff2 promisor-remote: allow a client to check fields
5: e8efe62b7f = 5: 149b275087 promisor-remote: use string constants for 'name' and 'url' too
Christian Couder (5):
promisor-remote: refactor to get rid of 'struct strvec'
promisor-remote: allow a server to advertise more fields
promisor-remote: refactor how we parse advertised fields
promisor-remote: allow a client to check fields
promisor-remote: use string constants for 'name' and 'url' too
Documentation/config/promisor.adoc | 62 ++++
Documentation/gitprotocol-v2.adoc | 59 +++-
promisor-remote.c | 401 +++++++++++++++++++++-----
t/t5710-promisor-remote-capability.sh | 65 +++++
4 files changed, 499 insertions(+), 88 deletions(-)
--
2.50.0.2.g875523421d
