[PATCH GSoC v6 00/10] cat-file: extend remote-object-info to support %(objecttype)

Pablo Sabater <[email protected]>
Newsgroups org.kernel.vger.git
Message-ID <[email protected]>
Neither the client nor the server knows how to handle type. This series
continues the work for git cat-file --batch-command extending
remote-object-info to support "%(objecttype)" end to end. It is based on
its predecessor series "cat-file: add remote-object-info to
batch-command" [1] merged into master.

Type is the last property that is identical on the server and on the
client once fetched.

Whether to support more metadata such as: - objectsize:disk
- deltabase
- objectmode (needs context)

should be discussed, unlike size and type, the rest depend on how things
are packed on the server and on what the client already has, so they
cannot reliably match local once fetched. IMO they are not worth
supporting, I can't find a use case for them.

To add a new placeholder, follow the steps in this series and add its
wants_* flag to struct fetch_object_info_results.

Patches 1-6 are preparatory. They don't change what the command does:
- [1/10] is a test cleanup.
- [2/10] fixes a possible bug in case of a malformed response.
- [3/10] and [4/10] refactor how the object data is stored and handled.
  The why about this refactor comes from [2].
- [5/10] drops the last error return left in fetch_object_info().
- [6/10] drops the remote object-info fields from the transport struct.

Patches 7-10 are the actual objecttype support:
- [7/10] teaches the server to answer type.
- [8/10] teaches the client to parse it.
- [9/10] advertises the capability so the client can start asking it.
- [10/10] unifies the default format.

Note that *_type appears from [8/10]. Before this series, "type" is
already listed in the client's allow-list, but the prep patches drop
that list, so the client knows nothing about type until [8/10] adds it
back.

I apologise for the spam as I've sent v5 and v6 very close together.

Github CI v6: https://github.com/pabloosabaterr/git/actions/runs/31227956862

Sorry for the inconveniences.

[1]: https://lore.kernel.org/git/[email protected]/
[2]: https://lore.kernel.org/git/[email protected]/

Signed-off-by: Pablo Sabater <[email protected]>
---
Changes in v6:
- Fixed static analysis CI fail with two forward declarations.
- Fixed s/%"PRIuMAX"/%" PRIuMAX "/
- Link to v5: https://lore.kernel.org/git/[email protected]

Changes in v5:
- New [6/10] by Jeff King: drop the remote object-info fields from the
  transport struct and pass them as function parameters instead.
- [5/10]: keep the const qualifiers on parameters of fetch_object_info(),
  matching how the signature was.
- Link to v4: https://lore.kernel.org/git/[email protected]/

Changes in v4:
- Rebased onto master now that ps/cat-file-remote-object-info was merged.
- Dropped the Based-on trailer.
- Reworded [1/9] so it shows that we also benefit from preserving the
  exit status.
- Changed [2/9] to also check if a response returns more packets.
- New [5/9]: fetch_object_info() dies on its last error return and
  becomes void.
- Moved the introduction of ask_type, wants_type to [7/9] instead of
  [4/9].
- Link to v3: https://lore.kernel.org/git/[email protected]/

Changes in v3:
- 1/8 (was 2/6): reword the commit message to explain that "wc -c | xargs"
  only strips the padding some platforms add.
- New 2/8: die if the server sends fewer object-info lines than
  requested OIDs. Preexisting bug.
- New 3/8: drop struct object_info_args and pass its members directly to
  fetch_object_info().
- New 4/8: replace struct object_info with struct
  fetch_object_info_results to hold the results. This also drops the
  object_info_options string list, remote_atom_map[] and
  free_object_info_contents().
- Dropped 1/6, which replaced the hardcoded "size" in
  send_object_info_request() with a loop over object_info_options, as
  that list no longer reaches it.
- 6/8: follows the new result struct, so it only adds the type array.
- 7/8: quote $hello_type in the test.
- Link to v2: https://lore.kernel.org/git/[email protected]/

Changes in v2:
- Changed t5701 test to use test_file_size.
- Changed the for loop to use for_each_string_list_item().
- Moved "fetch-object-info: request all supported options dynamically"
  patch to be the first one as it is prep patch.
- Typos and nits.
- Restored the test mixing info and remote-object-info, adapted to the
  unified format.
- Link to v1: https://lore.kernel.org/git/[email protected]/

---
Jeff King (1):
      transport: drop remote object-info fields from transport struct

Pablo Sabater (9):
      t5701: use test_file_size() to get the size of a file
      fetch-object-info: detect malformed server responses
      fetch-object-info: pass arguments directly instead of a struct
      fetch-object-info: use dedicated struct for the results
      fetch-object-info: die() on the remaining error path
      protocol-caps: add type support to object-info
      fetch-object-info: parse type from server response
      serve: advertise type capability
      cat-file: unify default format

 Documentation/git-cat-file.adoc        |  17 ++--
 Documentation/gitprotocol-v2.adoc      |  18 +++-
 builtin/cat-file.c                     |  73 +++++-----------
 fetch-object-info.c                    | 149 +++++++++++++++++++++------------
 fetch-object-info.h                    |  37 +++++---
 object-file.c                          |  10 ---
 odb.h                                  |   3 -
 protocol-caps.c                        |  21 ++++-
 serve.c                                |   4 +-
 t/t1017-cat-file-remote-object-info.sh |  78 ++++++++++-------
 t/t5701-git-serve.sh                   |  41 ++++++++-
 transport-helper.c                     |   7 +-
 transport-internal.h                   |   6 +-
 transport.c                            |  24 +++---
 transport.h                            |  10 +--
 15 files changed, 296 insertions(+), 202 deletions(-)

Range-diff versus v5:

 1:  77b048574a =  1:  99112fd453 t5701: use test_file_size() to get the size of a file
 2:  892e149f11 !  2:  e18da979aa fetch-object-info: detect malformed server responses
    @@ fetch-object-info.c: int fetch_object_info(const enum protocol_version version,
      	}
     +
     +	if (packet_reader_read(reader) != PACKET_READ_FLUSH)
    -+		die(_("object-info: expected flush after %"PRIuMAX" objects"),
    ++		die(_("object-info: expected flush after %" PRIuMAX " objects"),
     +		    (uintmax_t)args->oids->nr);
     +
      	check_stateless_delimiter(stateless_rpc, reader, "stateless delimiter expected");
 3:  05f4d26560 !  3:  8b4f6913c1 fetch-object-info: pass arguments directly instead of a struct
    @@ fetch-object-info.c: int fetch_object_info(const enum protocol_version version,
     @@ fetch-object-info.c: int fetch_object_info(const enum protocol_version version, struct object_info_ar
      
      	if (packet_reader_read(reader) != PACKET_READ_FLUSH)
    - 		die(_("object-info: expected flush after %"PRIuMAX" objects"),
    + 		die(_("object-info: expected flush after %" PRIuMAX " objects"),
     -		    (uintmax_t)args->oids->nr);
     +		    (uintmax_t)oids->nr);
      
 4:  832639ae1a =  4:  a81e1e3c1d fetch-object-info: use dedicated struct for the results
 5:  ffac30cef5 =  5:  a79f9957b4 fetch-object-info: die() on the remaining error path
 6:  748adf35fb !  6:  f14f3b0a2a transport: drop remote object-info fields from transport struct
    @@ transport-helper.c: static int fetch_refs(struct transport *transport,
      }
     
      ## transport-internal.h ##
    +@@ transport-internal.h: struct ref;
    + struct transport;
    + struct strvec;
    + struct transport_ls_refs_options;
    ++struct oid_array;
    ++struct fetch_object_info_results;
    + 
    + struct transport_vtable {
    + 	/**
     @@ transport-internal.h: struct transport_vtable {
      	 *
      	 * Uses object-info capability of v2 protocol.
 7:  c7ab410aef =  7:  c51d8ae137 protocol-caps: add type support to object-info
 8:  59da95f82c =  8:  1a9b320f36 fetch-object-info: parse type from server response
 9:  b249e9e16c =  9:  394bdd0885 serve: advertise type capability
10:  f8221fc1de = 10:  595b80c28d cat-file: unify default format

---
base-commit: 5b2471720c93ee30e5764a19f3d3b3ae9ec9712a
change-id: 20260724-objecttype-support-ea1ef6941d07
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.