fix conflicting push situation

In a situation where there are two repos that are diverged and each pushes
in turn to git-remote-annex, the first to push updates it. Then the second
push fails because it is not a fast-forward. The problem is, before git
push fails with "non-fast-forward", it actually calls git-remote-annex
with push.

So, to the user it appears as if the push failed, but it actually reached
the remote, and overwrote the other push!

The only solution to this seems to be for git-remote-annex push to notice
when a non-force-push would overwrite a ref stored in the remote, and
refuse to push that ref, returning an error to git. This seems strange,
why would git make remote helpers implement that when it later checks the
same thing itself?

With this fix, it's still possible for a race to overwrite a change to
the MANIFEST and lose work that was pushed from the other repo. But that
needs two pushes to be running at the same time. From the user's
perspective, that situation is the same as if one repo pushed new work,
then the other repo did a git push --force, overwriting the first repo's
push. In the first repo, another push will then fail as a non
fast-forward, and the user can recover as usual. But, a MANIFEST
overwrite will leave bundle files in the remote that are not listed in
the MANIFEST. It seems likely that git-annex will eventually be able to
detect that after the fact and clean it up. Eg, it can learn all bundles
that are stored in the remote using the location log, and compare them
to the MANIFEST to find bundles that got lost.

The race can also appear to the user as if they pushed a ref, but then
it got deleted from the remote. This happens when two two pushes are
pushing different ref names. This might be harder for the user to
notice; git fetch does not indicate that a remote ref got deleted.
They would have to use git fetch --prune to notice the deletion.
Once the user does notice, they can re-push their ref to recover.

Sponsored-by: Jack Hill on Patreon
This commit is contained in:
Joey Hess 2024-04-26 14:33:11 -04:00
parent 99491f572f
commit 8b56d6b283
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
2 changed files with 107 additions and 66 deletions

View file

@ -35,11 +35,9 @@ objects, but not refs.
objects
2. hash to calculate GITBUNDLE object name
3. upload GITBUNDLE object
4. download current manifest
5. remove all old GITBUNDLES from the manifest, and add new GITBUNDLE at
the end. Note that it's possible for the manifest to contain GITBUNDLES
that were not in the last fetched manifest, if so those must be
preserved, and the new GITBUNDLE appended
4. download old manifest
4. upload new manifest listing only the single new GITBUNDLE
5. delete all other GITBUNDLEs that were listed in the old manifest
# multiple GITMANIFEST files

View file

@ -7,6 +7,8 @@ set -x
# remember the refs that were uploaded already
git for-each-ref refs/namespaces/mine/ > .git/old-refs
rm -f .git/push-response
# Unfortunately, git bundle omits prerequisites that are omitted once,
# even if they are used by a later ref.
# For example, where x is a ref that points at A, and y is a ref
@ -42,10 +44,13 @@ while read foo; do
# includes all refs in its bundle.
f=$(tail -n 1 $TOPDIR/MANIFEST)
if [ -n "$f" ]; then
# stash the listed refs for later
# checking in push
git bundle list-heads $TOPDIR/$f > .git/listed-refs
# refs in the bundle may end up prefixed with refs/namespaces/mine/
# when the intent is for the bundle to include a
# ref with the name that comes after that.
git bundle list-heads $TOPDIR/$f | sed 's/refs\/namespaces\/mine\///'
sed 's/refs\/namespaces\/mine\///' .git/listed-refs
fi
fi
echo
@ -56,12 +61,13 @@ while read foo; do
push*)
set -- $foo
x="$2"
# src ref if prefixed with a + in a forced push
# src ref is prefixed with a + in a forced push
forcedpush=""
if echo "$x" | cut -d : -f 1 | egrep -q '^\+'; then
forcedpush=1
fi
srcref="$(echo "$x" | cut -d : -f 1 | sed 's/^\+//')"
dstref="$(echo "$x" | cut -d : -f 2)"
if [ -z "$srcref" ]; then
git update-ref -d refs/namespaces/mine/"$dstref"
else
# Need to create a bundle containing $dstref, but
# don't want to overwrite that ref in the local
# repo. Unfortunately, git bundle does not support
@ -70,7 +76,31 @@ while read foo; do
# Instead, just create a ref under the namespace
# refs/namespaces/mine/ that will be put in the
# bundle.
git update-ref refs/namespaces/mine/"$dstref" "$srcref"
mydstref=refs/namespaces/mine/"$dstref"
if [ -z "$srcref" ]; then
git update-ref -d "$mydstref"
touch .git/push-response
echo "ok $dstref" >> .git/push-response
else
if [ ! "$forcedpush" ]; then
# check if the push would overwrite
# work in the ref currently stored in the
# remote, if so refuse to do it
prevsha=$(grep " $mydstref$" .git/listed-refs | awk '{print $1}')
newsha=$(git rev-parse "$srcref")
if [ -n "$prevsha" ] && [ "$prevsha" != "$newsha" ] && [ -z "$(git log --oneline $prevsha..$newsha 2>/dev/null)" ]; then
touch .git/push-response
echo "error $dstref non-fast-forward" >> .git/push-response
else
touch .git/push-response
echo "ok $dstref" >> .git/push-response
git update-ref "$mydstref" "$srcref"
fi
else
git update-ref "$mydstref" "$srcref"
touch .git/push-response
echo "ok $dstref" >> .git/push-response
fi
fi
dopush=1
;;
@ -89,6 +119,16 @@ while read foo; do
dofetch=""
fi
if [ "$dopush" ]; then
# if some refs cannot be pushed, refuse to
# push anything. It would be difficult to
# push only some refs, because the bundle
# needs to contain all refs, and some refs
# on the remote may contain objects we have
# not fetched yet.
if egrep -q "^error" .git/push-response; then
sed 's/^ok \(.*\)/error \1 unable to push this due to other pushed ref being non-fast-forward/' .git/push-response > .git/push-response.new
mv .git/push-response.new .git/push-response
else
if [ -z "$(git for-each-ref refs/namespaces/mine/)" ]; then
# deleted all refs
if [ -e "$TOPDIR/MANIFEST" ]; then
@ -146,6 +186,9 @@ while read foo; do
mv $TOPDIR/new.bundle "$TOPDIR/$sha1.bundle"
echo "$sha1.bundle" >> $TOPDIR/MANIFEST
fi
fi
cat .git/push-response
rm -f .git/push-response
echo
dopush=""
fi