mirror of
https://github.com/go-gitea/gitea
synced 2024-12-21 03:44:18 +01:00
e461f0854f
* Make archival asynchronous The prime benefit being sought here is for large archives to not clog up the rendering process and cause unsightly proxy timeouts. As a secondary benefit, archive-in-progress is moved out of the way into a /tmp file so that new archival requests for the same commit will not get fulfilled based on an archive that isn't yet finished. This asynchronous system is fairly primitive; request comes in, we'll spawn off a new goroutine to handle it, then we'll mark it as done. Status requests will see if the file exists in the final location, and report the archival as done when it exists. Fixes #11265 * Archive links: drop initial delay to three-quarters of a second Some, or perhaps even most, archives will not take all that long to archive. The archive process starts as soon as the download button is initially clicked, so in theory they could be done quite quickly. Drop the initial delay down to three-quarters of a second to make it more responsive in the common case of the archive being quickly created. * archiver: restructure a little bit to facilitate testing This introduces two sync.Cond pointers to the archiver package. If they're non-nil when we go to process a request, we'll wait until signalled (at all) to proceed. The tests will then create the sync.Cond so that it can signal at-will and sanity-check the state of the queue at different phases. The author believes that nil-checking these two sync.Cond pointers on every archive processing will introduce minimal overhead with no impact on maintainability. * gofmt nit: no space around binary + operator * services: archiver: appease golangci-lint, lock queueMutex Locking/unlocking the queueMutex is allowed, but not required, for Cond.Signal() and Cond.Broadcast(). The magic at play here is just a little too much for golangci-lint, as we take the address of queueMutex and this is mostly used in archiver.go; the variable still gets flagged as unused. * archiver: tests: fix several timing nits Once we've signaled a cond var, it may take some small amount of time for the goroutines released to hit the spot we're wanting them to be at. Give them an appropriate amount of time. * archiver: tests: no underscore in var name, ungh * archiver: tests: Test* is run in a separate context than TestMain We must setup the mutex/cond variables at the beginning of any test that's going to use it, or else these will be nil when the test is actually ran. * archiver: tests: hopefully final tweak Things got shuffled around such that we carefully build up and release requests from the queue, so we can validate the state of the queue at each step. Fix some assertions that no longer hold true as fallout. * repo: Download: restore some semblance of previous behavior When archival was made async, the GET endpoint was only useful if a previous POST had initiated the download. This commit restores the previous behavior, to an extent; we'll now submit the archive request there and return a "202 Accepted" to indicate that it's processing if we didn't manage to complete the request within ~2 seconds of submission. This lets a client directly GET the archive, and gives them some indication that they may attempt to GET it again at a later time. * archiver: tests: simplify a bit further We don't need to risk failure and use time.ParseDuration to get 2 * time.Second. else if isn't really necessary if the conditions are simple enough and lead to the same result. * archiver: tests: resolve potential source of flakiness Increase all timeouts to 10 seconds; these aren't hard-coded sleeps, so there's no guarantee we'll actually take that long. If we need longer to not have a false-positive, then so be it. While here, various assert.{Not,}Equal arguments are flipped around so that the wording in error output reflects reality, where the expected argument is second and actual third. * archiver: setup infrastructure for notifying consumers of completion This API will *not* allow consumers to subscribe to specific requests being completed, just *any* request being completed. The caller is responsible for determining if their request is satisfied and waiting again if needed. * repo: archive: make GET endpoint synchronous again If the request isn't complete, this endpoint will now submit the request and wait for completion using the new API. This may still be susceptible to timeouts for larger repos, but other endpoints now exist that the web interface will use to negotiate its way through larger archive processes. * archiver: tests: amend test to include WaitForCompletion() This is a trivial one, so go ahead and include it. * archiver: tests: fix test by calling NewContext() The mutex is otherwise uninitialized, so we need to ensure that we're actually initializing it if we plan to test it. * archiver: tests: integrate new WaitForCompletion a little better We can use this to wait for archives to come in, rather than spinning and hoping with a timeout. * archiver: tests: combine numQueued declaration with next-instruction assignment * routers: repo: reap unused archiving flag from DownloadStatus() This had some planned usage before, indicating whether this request initiated the archival process or not. After several rounds of refactoring, this use was deemed not necessary for much of anything and got boiled down to !complete in all cases. * services: archiver: restructure to use a channel We now offer two forms of waiting for a request: - WaitForCompletion: wait for completion with no timeout - TimedWaitForCompletion: wait for completion with timeout In both cases, we wait for the given request's cchan to close; in the latter case, we do so with the caller-provided timeout. This completely removes the need for busy-wait loops in Download/InitiateDownload, as it's fairly clean to wait on a channel with timeout. * services: archiver: use defer to unlock now that we can This previously carried the lock into the goroutine, but an intermediate step just added the request to archiveInProgress outside of the new goroutine and removed the need for the goroutine to start out with it. * Revert "archiver: tests: combine numQueued declaration with next-instruction assignment" This reverts commitbcc5214023. Revert "archiver: tests: integrate new WaitForCompletion a little better" This reverts commit9fc8bedb56. Revert "archiver: tests: fix test by calling NewContext()" This reverts commit709c35685e. Revert "archiver: tests: amend test to include WaitForCompletion()" This reverts commit75261f56bc. * archiver: tests: first attempt at WaitForCompletion() tests * archiver: tests: slight improvement, less busy-loop Just wait for the requests to complete in order, instead of busy-waiting with a timeout. This is slightly less fragile. While here, reverse the arguments of a nearby assert.Equal() so that expected/actual are correct in any test output. * archiver: address lint nits * services: archiver: only close the channel once * services: archiver: use a struct{} for the wait channel This makes it obvious that the channel is only being used as a signal, rather than anything useful being piped through it. * archiver: tests: fix expectations Move the close of the channel into doArchive() itself; notably, before these goroutines move on to waiting on the Release cond. The tests are adjusted to reflect that we can't WaitForCompletion() after they've already completed, as WaitForCompletion() doesn't indicate that they've been released from the queue yet. * archiver: tests: set cchan to nil for comparison * archiver: move ctx.Error's back into the route handlers We shouldn't be setting this in a service, we should just be validating the request that we were handed. * services: archiver: use regex to match a hash This makes sure we don't try and use refName as a hash when it's clearly not one, e.g. heads/pull/foo. * routers: repo: remove the weird /archive/status endpoint We don't need to do this anymore, we can just continue POSTing to the archive/* endpoint until we're told the download's complete. This avoids a potential naming conflict, where a ref could start with "status/" * archiver: tests: bump reasonable timeout to 15s * archiver: tests: actually release timedReq * archiver: tests: run through inFlight instead of manually checking While we're here, add a test for manually re-processing an archive that's already been complete. Re-open the channel and mark it incomplete, so that doArchive can just mark it complete again. * initArchiveLinks: prevent default behavior from clicking * archiver: alias gitea's context, golang context import pending * archiver: simplify logic, just reconstruct slices While the previous logic was perhaps slightly more efficient, the new variant's readability is much improved. * archiver: don't block shutdown on waiting for archive The technique established launches a goroutine to do the wait, which will close a wait channel upon termination. For the timeout case, we also send back a value indicating whether the timeout was hit or not. The timeouts are expected to be relatively small, but still a multi- second delay to shutdown due to this could be unfortunate. * archiver: simplify shutdown logic We can just grab the shutdown channel from the graceful manager instead of constructing a channel to halt the caller and/or pass a result back. * Style issues * Fix mis-merge Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: Lauris BH <lauris@nix.lv>
169 lines
4.8 KiB
Bash
169 lines
4.8 KiB
Bash
#!/bin/sh
|
|
#
|
|
# Copyright (c) 2006, 2008 Junio C Hamano
|
|
#
|
|
# The "pre-rebase" hook is run just before "git rebase" starts doing
|
|
# its job, and can prevent the command from running by exiting with
|
|
# non-zero status.
|
|
#
|
|
# The hook is called with the following parameters:
|
|
#
|
|
# $1 -- the upstream the series was forked from.
|
|
# $2 -- the branch being rebased (or empty when rebasing the current branch).
|
|
#
|
|
# This sample shows how to prevent topic branches that are already
|
|
# merged to 'next' branch from getting rebased, because allowing it
|
|
# would result in rebasing already published history.
|
|
|
|
publish=next
|
|
basebranch="$1"
|
|
if test "$#" = 2
|
|
then
|
|
topic="refs/heads/$2"
|
|
else
|
|
topic=`git symbolic-ref HEAD` ||
|
|
exit 0 ;# we do not interrupt rebasing detached HEAD
|
|
fi
|
|
|
|
case "$topic" in
|
|
refs/heads/??/*)
|
|
;;
|
|
*)
|
|
exit 0 ;# we do not interrupt others.
|
|
;;
|
|
esac
|
|
|
|
# Now we are dealing with a topic branch being rebased
|
|
# on top of master. Is it OK to rebase it?
|
|
|
|
# Does the topic really exist?
|
|
git show-ref -q "$topic" || {
|
|
echo >&2 "No such branch $topic"
|
|
exit 1
|
|
}
|
|
|
|
# Is topic fully merged to master?
|
|
not_in_master=`git rev-list --pretty=oneline ^master "$topic"`
|
|
if test -z "$not_in_master"
|
|
then
|
|
echo >&2 "$topic is fully merged to master; better remove it."
|
|
exit 1 ;# we could allow it, but there is no point.
|
|
fi
|
|
|
|
# Is topic ever merged to next? If so you should not be rebasing it.
|
|
only_next_1=`git rev-list ^master "^$topic" ${publish} | sort`
|
|
only_next_2=`git rev-list ^master ${publish} | sort`
|
|
if test "$only_next_1" = "$only_next_2"
|
|
then
|
|
not_in_topic=`git rev-list "^$topic" master`
|
|
if test -z "$not_in_topic"
|
|
then
|
|
echo >&2 "$topic is already up to date with master"
|
|
exit 1 ;# we could allow it, but there is no point.
|
|
else
|
|
exit 0
|
|
fi
|
|
else
|
|
not_in_next=`git rev-list --pretty=oneline ^${publish} "$topic"`
|
|
/usr/bin/perl -e '
|
|
my $topic = $ARGV[0];
|
|
my $msg = "* $topic has commits already merged to public branch:\n";
|
|
my (%not_in_next) = map {
|
|
/^([0-9a-f]+) /;
|
|
($1 => 1);
|
|
} split(/\n/, $ARGV[1]);
|
|
for my $elem (map {
|
|
/^([0-9a-f]+) (.*)$/;
|
|
[$1 => $2];
|
|
} split(/\n/, $ARGV[2])) {
|
|
if (!exists $not_in_next{$elem->[0]}) {
|
|
if ($msg) {
|
|
print STDERR $msg;
|
|
undef $msg;
|
|
}
|
|
print STDERR " $elem->[1]\n";
|
|
}
|
|
}
|
|
' "$topic" "$not_in_next" "$not_in_master"
|
|
exit 1
|
|
fi
|
|
|
|
<<\DOC_END
|
|
|
|
This sample hook safeguards topic branches that have been
|
|
published from being rewound.
|
|
|
|
The workflow assumed here is:
|
|
|
|
* Once a topic branch forks from "master", "master" is never
|
|
merged into it again (either directly or indirectly).
|
|
|
|
* Once a topic branch is fully cooked and merged into "master",
|
|
it is deleted. If you need to build on top of it to correct
|
|
earlier mistakes, a new topic branch is created by forking at
|
|
the tip of the "master". This is not strictly necessary, but
|
|
it makes it easier to keep your history simple.
|
|
|
|
* Whenever you need to test or publish your changes to topic
|
|
branches, merge them into "next" branch.
|
|
|
|
The script, being an example, hardcodes the publish branch name
|
|
to be "next", but it is trivial to make it configurable via
|
|
$GIT_DIR/config mechanism.
|
|
|
|
With this workflow, you would want to know:
|
|
|
|
(1) ... if a topic branch has ever been merged to "next". Young
|
|
topic branches can have stupid mistakes you would rather
|
|
clean up before publishing, and things that have not been
|
|
merged into other branches can be easily rebased without
|
|
affecting other people. But once it is published, you would
|
|
not want to rewind it.
|
|
|
|
(2) ... if a topic branch has been fully merged to "master".
|
|
Then you can delete it. More importantly, you should not
|
|
build on top of it -- other people may already want to
|
|
change things related to the topic as patches against your
|
|
"master", so if you need further changes, it is better to
|
|
fork the topic (perhaps with the same name) afresh from the
|
|
tip of "master".
|
|
|
|
Let's look at this example:
|
|
|
|
o---o---o---o---o---o---o---o---o---o "next"
|
|
/ / / /
|
|
/ a---a---b A / /
|
|
/ / / /
|
|
/ / c---c---c---c B /
|
|
/ / / \ /
|
|
/ / / b---b C \ /
|
|
/ / / / \ /
|
|
---o---o---o---o---o---o---o---o---o---o---o "master"
|
|
|
|
|
|
A, B and C are topic branches.
|
|
|
|
* A has one fix since it was merged up to "next".
|
|
|
|
* B has finished. It has been fully merged up to "master" and "next",
|
|
and is ready to be deleted.
|
|
|
|
* C has not merged to "next" at all.
|
|
|
|
We would want to allow C to be rebased, refuse A, and encourage
|
|
B to be deleted.
|
|
|
|
To compute (1):
|
|
|
|
git rev-list ^master ^topic next
|
|
git rev-list ^master next
|
|
|
|
if these match, topic has not merged in next at all.
|
|
|
|
To compute (2):
|
|
|
|
git rev-list master..topic
|
|
|
|
if this is empty, it is fully merged to "master".
|
|
|
|
DOC_END
|