dolysis
/
ohmyzsh
3
0
Fork 0
Code Issues Pull Requests Releases Activity

feat(updater): add `background-alpha` update mode (preview) (#11928) 

NOTE: this feature is in alpha / preview mode, it is not guaranteed to work 100% of the
time in all cases. If you experience any issues, open an issue or search for an open
one describing your same situation.

To use this, use the zstyle update mode settings [1] with the value `background-alpha`:

  zstyle ':omz:update' mode background-alpha

[1] https://github.com/ohmyzsh/ohmyzsh#getting-updates
This commit is contained in:
Marc Cornellà 2023-10-09 18:00:17 +02:00 committed by GitHub
parent 30a8a5d3e2
commit 29b99c2c7b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 155 additions and 73 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

228
tools/check_for_upgrade.sh
View File

@ -9,6 +9,7 @@ fi
# - prompt (default): the user is asked before updating when it's time to update # - prompt (default): the user is asked before updating when it's time to update
# - auto: the update is performed automatically when it's time # - auto: the update is performed automatically when it's time
# - reminder: a reminder is shown to the user when it's time to update # - reminder: a reminder is shown to the user when it's time to update
# - background-alpha: an experimental update-on-the-background option
# - disabled: automatic update is turned off # - disabled: automatic update is turned off
zstyle -s ':omz:update' mode update_mode || { zstyle -s ':omz:update' mode update_mode || {
update_mode=prompt update_mode=prompt
@ -91,13 +92,37 @@ function is_update_available() {
} }
function update_last_updated_file() { function update_last_updated_file() {
echo "LAST_EPOCH=$(current_epoch)" >! "${ZSH_CACHE_DIR}/.zsh-update" local exit_status="$1" error="$2"
if [[ -z "${1}${2}" ]]; then
echo "LAST_EPOCH=$(current_epoch)" >! "${ZSH_CACHE_DIR}/.zsh-update"
return
fi
cat >! "${ZSH_CACHE_DIR}/.zsh-update" <<EOD
LAST_EPOCH=$(current_epoch)
EXIT_STATUS=${exit_status}
ERROR='${error//\'/’}'
EOD
} }
function update_ohmyzsh() { function update_ohmyzsh() {
local verbose_mode
zstyle -s ':omz:update' verbose verbose_mode || verbose_mode=default zstyle -s ':omz:update' verbose verbose_mode || verbose_mode=default
if ZSH="$ZSH" zsh -f "$ZSH/tools/upgrade.sh" -i -v $verbose_mode; then
if [[ "$update_mode" != background-alpha ]] \
&& LANG= ZSH="$ZSH" zsh -f "$ZSH/tools/upgrade.sh" -i -v $verbose_mode; then
update_last_updated_file update_last_updated_file
return $?
fi
local exit_status error
if error=$(LANG= ZSH="$ZSH" zsh -f "$ZSH/tools/upgrade.sh" -i -v silent 2>&1); then
update_last_updated_file 0 "Update successful"
else
exit_status=$?
update_last_updated_file $exit_status "$error"
return $exit_status
fi fi
} }
@ -126,88 +151,145 @@ function has_typed_input() {
} }
} }
() { function handle_update() {
emulate -L zsh () {
emulate -L zsh
local epoch_target mtime option LAST_EPOCH local epoch_target mtime option LAST_EPOCH
# Remove lock directory if older than a day # Remove lock directory if older than a day
zmodload zsh/datetime zmodload zsh/datetime
zmodload -F zsh/stat b:zstat zmodload -F zsh/stat b:zstat
if mtime=$(zstat +mtime "$ZSH/log/update.lock" 2>/dev/null); then if mtime=$(zstat +mtime "$ZSH/log/update.lock" 2>/dev/null); then
if (( (mtime + 3600 * 24) < EPOCHSECONDS )); then if (( (mtime + 3600 * 24) < EPOCHSECONDS )); then
command rm -rf "$ZSH/log/update.lock" command rm -rf "$ZSH/log/update.lock"
fi
fi fi
fi
# Check for lock directory # Check for lock directory
if ! command mkdir "$ZSH/log/update.lock" 2>/dev/null; then if ! command mkdir "$ZSH/log/update.lock" 2>/dev/null; then
return return
fi fi
# Remove lock directory on exit. `return $ret` is important for when trapping a SIGINT: # Remove lock directory on exit. `return $ret` is important for when trapping a SIGINT:
# The return status from the function is handled specially. If it is zero, the signal is # The return status from the function is handled specially. If it is zero, the signal is
# assumed to have been handled, and execution continues normally. Otherwise, the shell # assumed to have been handled, and execution continues normally. Otherwise, the shell
# will behave as interrupted except that the return status of the trap is retained. # will behave as interrupted except that the return status of the trap is retained.
# This means that for a CTRL+C, the trap needs to return the same exit status so that # This means that for a CTRL+C, the trap needs to return the same exit status so that
# the shell actually exits what it's running. # the shell actually exits what it's running.
trap " trap "
ret=\$? ret=\$?
unset update_mode unset update_mode
unset -f current_epoch is_update_available update_last_updated_file update_ohmyzsh 2>/dev/null unset -f current_epoch is_update_available update_last_updated_file update_ohmyzsh handle_update 2>/dev/null
command rm -rf '$ZSH/log/update.lock' command rm -rf '$ZSH/log/update.lock'
return \$ret return \$ret
" EXIT INT QUIT " EXIT INT QUIT
# Create or update .zsh-update file if missing or malformed # Create or update .zsh-update file if missing or malformed
if ! source "${ZSH_CACHE_DIR}/.zsh-update" 2>/dev/null || [[ -z "$LAST_EPOCH" ]]; then if ! source "${ZSH_CACHE_DIR}/.zsh-update" 2>/dev/null || [[ -z "$LAST_EPOCH" ]]; then
update_last_updated_file update_last_updated_file
return return
fi fi
# Number of days before trying to update again # Number of days before trying to update again
zstyle -s ':omz:update' frequency epoch_target || epoch_target=${UPDATE_ZSH_DAYS:-13} zstyle -s ':omz:update' frequency epoch_target || epoch_target=${UPDATE_ZSH_DAYS:-13}
# Test if enough time has passed until the next update # Test if enough time has passed until the next update
if (( ( $(current_epoch) - $LAST_EPOCH ) < $epoch_target )); then if (( ( $(current_epoch) - $LAST_EPOCH ) < $epoch_target )); then
return return
fi fi
# Test if Oh My Zsh directory is a git repository # Test if Oh My Zsh directory is a git repository
if ! (builtin cd -q "$ZSH" && LANG= git rev-parse &>/dev/null); then if ! (builtin cd -q "$ZSH" && LANG= git rev-parse &>/dev/null); then
echo >&2 "[oh-my-zsh] Can't update: not a git repository." echo >&2 "[oh-my-zsh] Can't update: not a git repository."
return return
fi fi
# Check if there are updates available before proceeding # Check if there are updates available before proceeding
if ! is_update_available; then if ! is_update_available; then
update_last_updated_file update_last_updated_file
return return
fi fi
# If in reminder mode or user has typed input, show reminder and exit # If in reminder mode or user has typed input, show reminder and exit
if [[ "$update_mode" = reminder ]] || has_typed_input; then if [[ "$update_mode" = reminder ]] || { [[ "$update_mode" != background-alpha ]] && has_typed_input }; then
printf '\r\e[0K' # move cursor to first column and clear whole line printf '\r\e[0K' # move cursor to first column and clear whole line
echo "[oh-my-zsh] It's time to update! You can do that by running \`omz update\`" echo "[oh-my-zsh] It's time to update! You can do that by running \`omz update\`"
return 0 return 0
fi fi
# Don't ask for confirmation before updating if in auto mode # Don't ask for confirmation before updating if in auto mode
if [[ "$update_mode" = auto ]]; then if [[ "$update_mode" = (auto|background-alpha) ]]; then
update_ohmyzsh update_ohmyzsh
return $? return $?
fi fi
# Ask for confirmation and only update on 'y', 'Y' or Enter # Ask for confirmation and only update on 'y', 'Y' or Enter
# Otherwise just show a reminder for how to update # Otherwise just show a reminder for how to update
echo -n "[oh-my-zsh] Would you like to update? [Y/n] " echo -n "[oh-my-zsh] Would you like to update? [Y/n] "
read -r -k 1 option read -r -k 1 option
[[ "$option" = $'\n' ]] || echo [[ "$option" = $'\n' ]] || echo
case "$option" in case "$option" in
[yY$'\n']) update_ohmyzsh ;; [yY$'\n']) update_ohmyzsh ;;
[nN]) update_last_updated_file ;& [nN]) update_last_updated_file ;&
*) echo "[oh-my-zsh] You can update manually by running \`omz update\`" ;; *) echo "[oh-my-zsh] You can update manually by running \`omz update\`" ;;
esac esac
}
unset update_mode
unset -f current_epoch is_update_available update_last_updated_file update_ohmyzsh handle_update
} }
unset update_mode case "$update_mode" in
unset -f current_epoch is_update_available update_last_updated_file update_ohmyzsh background-alpha)
autoload -Uz add-zsh-hook
_omz_bg_update() {
# do the update in a subshell
(handle_update) &|
# register update results function
add-zsh-hook precmd _omz_bg_update_status
# deregister background function
add-zsh-hook -d precmd _omz_bg_update
unset -f _omz_bg_update
}
_omz_bg_update_status() {
{
local LAST_EPOCH EXIT_STATUS ERROR
if [[ ! -f "$ZSH_CACHE_DIR"/.zsh-update ]]; then
return 1
fi
# check update results until timeout is reached
. "$ZSH_CACHE_DIR/.zsh-update"
if [[ -z "$EXIT_STATUS" || -z "$ERROR" ]]; then
return 1
fi
if [[ "$EXIT_STATUS" -eq 0 ]]; then
print -P "\n%F{green}[oh-my-zsh] Update successful.%f"
return 0
elif [[ "$EXIT_STATUS" -ne 0 ]]; then
print -P "\n%F{red}[oh-my-zsh] There was an error updating:%f"
printf "\n${fg[yellow]}%s${reset_color}" "$ERROR"
return 0
fi
} always {
if (( TRY_BLOCK_ERROR == 0 )); then
# if last update results have been handled, remove them from the status file
update_last_updated_file
# deregister background function
add-zsh-hook -d precmd _omz_bg_update_status
unset -f _omz_bg_update_status
fi
}
}
add-zsh-hook precmd _omz_bg_update
;;
*)
handle_update ;;
esac