send-pack: new return code "ERROR_SEND_PACK_BAD_REF_STATUS"

The "push_refs" function in the transport_vtable is the handler for git-push operation. All the "push_refs" functions for different transports (protocols) should have the same behavior, but the behavior of "git_transport_push()" function for builtin_smart_vtable in "transport.c" (which calls "send_pack()" in "send-pack.c") differs from the handler of the HTTP protocol. The "push_refs()" function for the HTTP protocol which calls the "push_refs_with_push()" function in "transport-helper.c" will return 0 even when a bad REF_STATUS (such as REF_STATUS_REJECT_NONFASTFORWARD) was found. But "send_pack()" for Git smart protocol will return -1 for a bad REF_STATUS. We cannot ignore bad REF_STATUS directly in the "send_pack()" function, because the function is also used in "builtin/send-pack.c". So we add a new non-zero error code "SEND_PACK_ERROR_REF_STATUS" for "send_pack()". Ignore the specific error code in the "git_transport_push()" function to have the same behavior as "push_refs()" for HTTP protocol. Note that even though we ignore the error here, we'll ultimately still end up detecting that a subset of refs was not pushed in `transport_push()` because we eventually call `push_had_errors()` on the remote refs. Signed-off-by: Jiang Xin <zhiyou.jx@alibaba-inc.com> Signed-off-by: Patrick Steinhardt <ps@pks.im> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Jiang Xin committed Feb 3, 2025 at 07:29 UTC 3028db4af289560e670b9f362aea16eaf3d1825e
3 files changed +22 -7
send-pack.c
+2 -7
@@ -632,7 +632,7 @@ int send_pack(struct repository *r,
632 reject_atomic_push(remote_refs, args->send_mirror);
633 error("atomic push failed for ref %s. status: %d",
634 ref->name, ref->status);
635 - ret = args->porcelain ? 0 : -1;
635 + ret = ERROR_SEND_PACK_BAD_REF_STATUS;
636 goto out;
637 }
638 /* else fallthrough */
@@ -763,11 +763,6 @@ int send_pack(struct repository *r,
763 if (ret < 0)
764 goto out;
765
766 - if (args->porcelain) {
767 - ret = 0;
768 - goto out;
769 - }
770 -
766 for (ref = remote_refs; ref; ref = ref->next) {
767 switch (ref->status) {
768 case REF_STATUS_NONE:
@@ -775,7 +770,7 @@ int send_pack(struct repository *r,
770 case REF_STATUS_OK:
771 break;
772 default:
778 - ret = -1;
773 + ret = ERROR_SEND_PACK_BAD_REF_STATUS;
774 goto out;
775 }
776 }
send-pack.h
+13
@@ -13,6 +13,9 @@ struct repository;
13 #define SEND_PACK_PUSH_CERT_IF_ASKED 1
14 #define SEND_PACK_PUSH_CERT_ALWAYS 2
15
16 +/* At least one reference has been rejected by the remote side. */
17 +#define ERROR_SEND_PACK_BAD_REF_STATUS 1
18 +
19 struct send_pack_args {
20 const char *url;
21 unsigned verbose:1,
@@ -36,6 +39,16 @@ struct option;
39 int option_parse_push_signed(const struct option *opt,
40 const char *arg, int unset);
41
42 +/*
43 + * Compute a packfile and write it to a file descriptor. The `fd` array needs
44 + * to contain two file descriptors: `fd[0]` is the file descriptor used as
45 + * input for the packet reader, whereas `fd[1]` is the file descriptor the
46 + * packfile will be written to.
47 + *
48 + * Returns 0 on success, non-zero otherwise. Negative return values indicate a
49 + * generic error, whereas positive return values indicate specific error
50 + * conditions as documented with the `ERROR_SEND_PACK_*` constants.
51 + */
52 int send_pack(struct repository *r, struct send_pack_args *args,
53 int fd[], struct child_process *conn,
54 struct ref *remote_refs, struct oid_array *extra_have);
transport.c
+7
@@ -934,6 +934,13 @@ static int git_transport_push(struct transport *transport, struct ref *remote_re
934 case protocol_v0:
935 ret = send_pack(the_repository, &args, data->fd, data->conn, remote_refs,
936 &data->extra_have);
937 + /*
938 + * Ignore the specific error code to maintain consistent behavior
939 + * with the "push_refs()" function across different transports,
940 + * such as "push_refs_with_push()" for HTTP protocol.
941 + */
942 + if (ret == ERROR_SEND_PACK_BAD_REF_STATUS)
943 + ret = 0;
944 break;
945 case protocol_unknown_version:
946 BUG("unknown protocol version");