Skip to content
  • Jonathan Tan's avatar
    fetch-pack: unify ref in and out param · e2842b39
    Jonathan Tan authored and Junio C Hamano's avatar Junio C Hamano committed
    When a user fetches:
     - at least one up-to-date ref and at least one non-up-to-date ref,
     - using HTTP with protocol v0 (or something else that uses the fetch
       command of a remote helper)
    some refs might not be updated after the fetch.
    
    This bug was introduced in commit 989b8c44 ("fetch-pack: put shallow
    info in output parameter", 2018-06-28) which allowed transports to
    report the refs that they have fetched in a new out-parameter
    "fetched_refs". If they do so, transport_fetch_refs() makes this
    information available to its caller.
    
    Users of "fetched_refs" rely on the following 3 properties:
     (1) it is the complete list of refs that was passed to
         transport_fetch_refs(),
     (2) it has shallow information (REF_STATUS_REJECT_SHALLOW set if
         relevant), and
     (3) it has updated OIDs if ref-in-want was used (introduced after
         989b8c44).
    
    In an effort to satisfy (1), whenever transport_fetch_refs()
    filters the refs sent to the transport, it re-adds the filtered refs to
    whatever the transport supplies before returning it to the user.
    However, the implementation in 989b8c44 unconditionally re-adds the
    filtered refs without checking if the transport refrained from reporting
    anything in "fetched_refs" (which it is allowed to do), resulting in an
    incomplete list, no longer satisfying (1).
    
    An earlier effort to resolve this [1] solved the issue by readding the
    filtered refs only if the transport did not refrain from reporting in
    "fetched_refs", but after further discussion, it seems that the better
    solution is to revert the API change that introduced "fetched_refs".
    This API change was first suggested as part of a ref-in-want
    implementation that allowed for ref patterns and, thus, there could be
    drastic differences between the input refs and the refs actually fetched
    [2]; we eventually decided to only allow exact ref names, but this API
    change remained even though its necessity was decreased.
    
    Therefore, revert this API change by reverting commit 989b8c44, and
    make receive_wanted_refs() update the OIDs in the sought array (like how
    update_shallow() updates shallow information in the sought array)
    instead. A test is also included to show that the user-visible bug
    discussed at the beginning of this commit message no longer exists.
    
    [1] https://public-inbox.org/git/20180801171806.GA122458@google.com/
    [2] https://public-inbox.org/git/86a128c5fb710a41791e7183207c4d64889f9307.1485381677.git.jonathantanmy@google.com/
    
    
    
    Signed-off-by: default avatarJonathan Tan <jonathantanmy@google.com>
    Signed-off-by: default avatarJunio C Hamano <gitster@pobox.com>
    e2842b39