fix: hold the deploy lock across git-from-directory and harden the advisory lock
git-from-directory updated the deploy branch before taking the deploy lock and rolled it back after releasing it. The lock is now held for the whole update, build, and rollback, and the rollback only moves the branch if it still points at the commit that was created. A failed lock attempt and apps:lock both truncated the lock file, dropping the build id of the in-progress deploy that builds:cancel and builds:output read. Releasing the lock unlocked before removing the file, so a waiter could end up holding a lock on a deleted file while another deploy locked a new one. The file is now removed before unlocking, and acquiring retries when the locked file is no longer the one at the lock path.
This commit is contained in:
8 files changed
+312
-56
No files matched your search
@@ -137,8 +137,13 @@ func CommandLock(appName string) error {
|
||||
return err
|
||||
}
|
||||
|
||||
// the file is not truncated as it may hold the build id of an in-progress deploy
|
||||
lockPath := getLockPath(appName)
|
||||
if _, err := os.Create(lockPath); err != nil {
|
||||
lockFile, err := os.OpenFile(lockPath, os.O_CREATE|os.O_WRONLY, 0644)
|
||||
if err != nil {
|
||||
return errors.New("Unable to create deploy lock")
|
||||
}
|
||||
if err := lockFile.Close(); err != nil {
|
||||
return errors.New("Unable to create deploy lock")
|
||||
}
|
||||
|
||||
|
||||
+42
-19
@@ -980,11 +980,17 @@ dokku_discard_build_capture() {
|
||||
unset DOKKU_BUILD_ID DOKKU_BUILD_LOG_FILE DOKKU_BUILD_SOURCE
|
||||
}
|
||||
|
||||
app_deploy_lock_file() {
|
||||
declare desc="outputs the path to the deploy lock file for an app"
|
||||
declare APP="$1"
|
||||
echo "$DOKKU_LIB_ROOT/data/apps/$APP/.deploy.lock"
|
||||
}
|
||||
|
||||
acquire_app_deploy_lock() {
|
||||
declare desc="acquire advisory lock for use in deploys"
|
||||
local APP="$1"
|
||||
local LOCK_TYPE="${2:-waiting}"
|
||||
local APP_DEPLOY_LOCK_FILE="$DOKKU_LIB_ROOT/data/apps/$APP/.deploy.lock"
|
||||
local APP_DEPLOY_LOCK_FILE="$(app_deploy_lock_file "$APP")"
|
||||
local LOCK_WAITING_MSG="$APP currently has a deploy lock in place. Waiting..."
|
||||
local LOCK_FAILED_MSG="$APP currently has a deploy lock in place. Exiting..."
|
||||
|
||||
@@ -1003,7 +1009,7 @@ release_app_deploy_lock() {
|
||||
declare desc="release advisory lock used in deploys"
|
||||
local APP="$1"
|
||||
local EXIT_CODE="${2:-0}"
|
||||
local APP_DEPLOY_LOCK_FILE="$DOKKU_LIB_ROOT/data/apps/$APP/.deploy.lock"
|
||||
local APP_DEPLOY_LOCK_FILE="$(app_deploy_lock_file "$APP")"
|
||||
|
||||
if [[ -n "$DOKKU_BUILD_ID" ]]; then
|
||||
plugn trigger builds-record-finalize "$APP" "$DOKKU_BUILD_ID" "$EXIT_CODE" || true
|
||||
@@ -1018,24 +1024,35 @@ acquire_advisory_lock() {
|
||||
local LOCK_FD="200"
|
||||
local SHOW_MSG=true
|
||||
|
||||
eval "exec $LOCK_FD>$LOCK_FILE"
|
||||
if [[ "$LOCK_TYPE" == "waiting" ]]; then
|
||||
while [[ $(
|
||||
flock -n "$LOCK_FD" &>/dev/null
|
||||
echo $?
|
||||
) -ne 0 ]]; do
|
||||
if [[ "$SHOW_MSG" == "true" ]]; then
|
||||
echo "$LOCK_WAITING_MSG"
|
||||
SHOW_MSG=false
|
||||
while true; do
|
||||
# opened for appending so a failed attempt does not truncate the build id
|
||||
# written by the current lock holder
|
||||
eval "exec $LOCK_FD>>$LOCK_FILE"
|
||||
if [[ "$LOCK_TYPE" == "waiting" ]]; then
|
||||
while [[ $(
|
||||
flock -n "$LOCK_FD" &>/dev/null
|
||||
echo $?
|
||||
) -ne 0 ]]; do
|
||||
if [[ "$SHOW_MSG" == "true" ]]; then
|
||||
echo "$LOCK_WAITING_MSG"
|
||||
SHOW_MSG=false
|
||||
fi
|
||||
sleep 1
|
||||
done
|
||||
else
|
||||
if ! flock -n "$LOCK_FD" &>/dev/null; then
|
||||
dokku_log_warn "$LOCK_FAILED_MSG"
|
||||
dokku_log_fail "Run 'apps:unlock' to release the existing deploy lock"
|
||||
fi
|
||||
sleep 1
|
||||
done
|
||||
else
|
||||
if ! flock -n "$LOCK_FD" &>/dev/null; then
|
||||
dokku_log_warn "$LOCK_FAILED_MSG"
|
||||
dokku_log_fail "Run 'apps:unlock' to release the existing deploy lock"
|
||||
fi
|
||||
fi
|
||||
|
||||
# the previous holder removes the lock file on release, so the file locked
|
||||
# above may no longer be the one at the lock path
|
||||
if [[ "/proc/self/fd/$LOCK_FD" -ef "$LOCK_FILE" ]]; then
|
||||
break
|
||||
fi
|
||||
eval "exec $LOCK_FD>&-"
|
||||
done
|
||||
echo "${DOKKU_BUILD_ID:-$DOKKU_PID}" >"$LOCK_FILE"
|
||||
}
|
||||
|
||||
@@ -1044,7 +1061,13 @@ release_advisory_lock() {
|
||||
local LOCK_FILE="$1"
|
||||
local LOCK_FD="200"
|
||||
|
||||
flock -u "$LOCK_FD" && rm -f "$LOCK_FILE" &>/dev/null
|
||||
# the file is removed before unlocking so a waiter that locks it afterwards
|
||||
# can tell that its lock is stale. It is only removed if it is still the file
|
||||
# this process locked, as apps:unlock may have handed the path to another deploy
|
||||
if [[ "/proc/self/fd/$LOCK_FD" -ef "$LOCK_FILE" ]]; then
|
||||
rm -f "$LOCK_FILE" &>/dev/null
|
||||
fi
|
||||
flock -u "$LOCK_FD"
|
||||
}
|
||||
|
||||
suppress_output() {
|
||||
|
||||
+24
-16
@@ -150,28 +150,36 @@ git_receive_app() {
|
||||
if [[ ! -d "$DOKKU_ROOT/$APP/refs" ]]; then
|
||||
true
|
||||
else
|
||||
local exit_code=0 has_source_image=false source_image previous_source_image
|
||||
local exit_code=0
|
||||
acquire_app_deploy_lock "$APP" "exclusive"
|
||||
|
||||
# DOKKU_GIT_SOURCE_IMAGE is only applied while the deploy lock is held. An
|
||||
# empty value clears the property, while an unset variable leaves it as-is.
|
||||
if [[ -n "${DOKKU_GIT_SOURCE_IMAGE+x}" ]]; then
|
||||
has_source_image=true
|
||||
source_image="$DOKKU_GIT_SOURCE_IMAGE"
|
||||
unset DOKKU_GIT_SOURCE_IMAGE
|
||||
previous_source_image="$(fn-git-source-image "$APP")"
|
||||
fn-plugin-property-write "git" "$APP" "source-image" "$source_image"
|
||||
fi
|
||||
|
||||
(git_build "$APP" "$REV") || exit_code="$?"
|
||||
if [[ "$exit_code" -ne 0 ]] && [[ "$has_source_image" == "true" ]]; then
|
||||
fn-plugin-property-write "git" "$APP" "source-image" "$previous_source_image"
|
||||
fi
|
||||
fn-git-build-with-lock-held "$APP" "$REV" || exit_code="$?"
|
||||
release_app_deploy_lock "$APP" "$exit_code"
|
||||
return "$exit_code"
|
||||
fi
|
||||
}
|
||||
|
||||
fn-git-build-with-lock-held() {
|
||||
declare desc="builds an app at a revision, expecting the caller to hold the app deploy lock"
|
||||
declare APP="$1" REV="$2"
|
||||
local exit_code=0 has_source_image=false source_image previous_source_image
|
||||
|
||||
# DOKKU_GIT_SOURCE_IMAGE is only applied while the deploy lock is held. An
|
||||
# empty value clears the property, while an unset variable leaves it as-is.
|
||||
if [[ -n "${DOKKU_GIT_SOURCE_IMAGE+x}" ]]; then
|
||||
has_source_image=true
|
||||
source_image="$DOKKU_GIT_SOURCE_IMAGE"
|
||||
unset DOKKU_GIT_SOURCE_IMAGE
|
||||
previous_source_image="$(fn-git-source-image "$APP")"
|
||||
fn-plugin-property-write "git" "$APP" "source-image" "$source_image"
|
||||
fi
|
||||
|
||||
(git_build "$APP" "$REV") || exit_code="$?"
|
||||
if [[ "$exit_code" -ne 0 ]] && [[ "$has_source_image" == "true" ]]; then
|
||||
fn-plugin-property-write "git" "$APP" "source-image" "$previous_source_image"
|
||||
fi
|
||||
return "$exit_code"
|
||||
}
|
||||
|
||||
cmd-git-upload-pack() {
|
||||
declare desc="executes git-upload-pack"
|
||||
declare cmd="git-upload-pack"
|
||||
|
||||
@@ -5,20 +5,19 @@ source "$PLUGIN_AVAILABLE_PATH/git/internal-functions"
|
||||
set -eo pipefail
|
||||
[[ $DOKKU_TRACE ]] && set -x
|
||||
|
||||
trigger-git-git-from-directory() {
|
||||
declare desc="updates a repository from a directory"
|
||||
declare trigger="git-from-directory"
|
||||
declare APP="$1" SOURCECODE_WORK_DIR="$2" USER_NAME="${3:-Dokku}" USER_EMAIL="${4:-automated@dokku.sh}"
|
||||
fn-git-from-directory-with-lock-held() {
|
||||
declare desc="updates a repository from a directory and builds it, expecting the caller to hold the app deploy lock"
|
||||
declare APP="$1" SOURCECODE_WORK_DIR="$2" USER_NAME="$3" USER_EMAIL="$4"
|
||||
|
||||
local APP_ROOT="$DOKKU_ROOT/$APP"
|
||||
local DOKKU_DEPLOY_BRANCH="$(fn-git-computed-deploy-branch "$APP")"
|
||||
local REV
|
||||
local REV PREVIOUS_REV
|
||||
local TMP_WORK_DIR=$(mktemp -d "/tmp/dokku-${DOKKU_PID}-${FUNCNAME[0]}.XXXXXX")
|
||||
local TMP_WORK_DIR_2=$(mktemp -d "/tmp/dokku-${DOKKU_PID}-${FUNCNAME[0]}.XXXXXX")
|
||||
trap "rm -rf '$TMP_WORK_DIR' '$TMP_WORK_DIR_2' >/dev/null" RETURN INT TERM EXIT
|
||||
|
||||
local has_code=false
|
||||
if fn-git-cmd "$APP_ROOT" rev-parse "$DOKKU_DEPLOY_BRANCH" &>/dev/null; then
|
||||
if PREVIOUS_REV="$(fn-git-cmd "$APP_ROOT" rev-parse "$DOKKU_DEPLOY_BRANCH" 2>/dev/null)"; then
|
||||
has_code=true
|
||||
fi
|
||||
|
||||
@@ -60,19 +59,39 @@ trigger-git-git-from-directory() {
|
||||
fi
|
||||
|
||||
rm -rf "$TMP_WORK_DIR" "$TMP_WORK_DIR_2" >/dev/null
|
||||
# run in a subshell so a failure to acquire the deploy lock still reaches the rollback
|
||||
if (git_receive_app "$APP" "$REV"); then
|
||||
if fn-git-build-with-lock-held "$APP" "$REV"; then
|
||||
return
|
||||
else
|
||||
local exit_code=$?
|
||||
local DOKKU_DEPLOY_BRANCH="$(fn-git-computed-deploy-branch "$APP")"
|
||||
# only roll back the deploy branch if it still points at the commit created above
|
||||
if [[ "$has_code" == "false" ]]; then
|
||||
fn-git-cmd "$APP_ROOT" update-ref -d HEAD
|
||||
fn-git-cmd "$APP_ROOT" update-ref -d "refs/heads/$DOKKU_DEPLOY_BRANCH" "$REV" || dokku_log_warn "Unable to roll back the $DOKKU_DEPLOY_BRANCH branch"
|
||||
else
|
||||
fn-git-cmd "$APP_ROOT" update-ref "refs/heads/$DOKKU_DEPLOY_BRANCH" "$DOKKU_DEPLOY_BRANCH^"
|
||||
fn-git-cmd "$APP_ROOT" update-ref "refs/heads/$DOKKU_DEPLOY_BRANCH" "$PREVIOUS_REV" "$REV" || dokku_log_warn "Unable to roll back the $DOKKU_DEPLOY_BRANCH branch"
|
||||
fi
|
||||
return "$exit_code"
|
||||
fi
|
||||
}
|
||||
|
||||
trigger-git-git-from-directory() {
|
||||
declare desc="updates a repository from a directory"
|
||||
declare trigger="git-from-directory"
|
||||
declare APP="$1" SOURCECODE_WORK_DIR="$2" USER_NAME="${3:-Dokku}" USER_EMAIL="${4:-automated@dokku.sh}"
|
||||
local exit_code=0
|
||||
|
||||
# the lock is held from before the deploy branch is updated until after it is
|
||||
# rolled back, and the subshell ensures it is released on any failure
|
||||
acquire_app_deploy_lock "$APP" "exclusive"
|
||||
set +e
|
||||
(
|
||||
set -e
|
||||
fn-git-from-directory-with-lock-held "$APP" "$SOURCECODE_WORK_DIR" "$USER_NAME" "$USER_EMAIL"
|
||||
)
|
||||
exit_code="$?"
|
||||
set -e
|
||||
release_app_deploy_lock "$APP" "$exit_code"
|
||||
return "$exit_code"
|
||||
}
|
||||
|
||||
trigger-git-git-from-directory "$@"
|
||||
@@ -279,7 +279,7 @@ cmd-git-sync() {
|
||||
fi
|
||||
|
||||
local APP_ROOT="$DOKKU_ROOT/$APP"
|
||||
local APP_DEPLOY_LOCK_FILE="$DOKKU_LIB_ROOT/data/apps/$APP/.deploy.lock"
|
||||
local APP_DEPLOY_LOCK_FILE="$(app_deploy_lock_file "$APP")"
|
||||
local fetch_exit_code=0
|
||||
|
||||
dokku_setup_build_capture "$APP" "git:sync"
|
||||
|
||||
Reference in new issue
Block a user