Fix issues with LASTWIDGET caused by async suggestions

There are a number of widgets that rely on LASTWIDGET so that they can
chain their behavior together on subsequent invocations. When a
suggestion was fetched asynchronously, the widget showing the suggestion
would overwrite LASTWIDGET and break these widgets that rely on it.
Relatively recently, a flag was added to the `zle` builtin to opt out of
setting LASTWIDGET when calling a widget. We can use that flag to avoid
setting LASTWIDGET when displaying suggestions that were fetched
asynchronously.

CHANGELOG.md

@@ -1,12 +1,5 @@
 # Changelog
 
-## v0.7.1
-- Clear POSTDISPLAY instead of unsetting (#634)
-- Always reset async file descriptor after consuming it (#630)
-- Always use builtin `exec` (#628)
-- Add `history-beginning-search-*-end` widgets to clear widget list (#619)
-- Switch CI from Circle CI to GitHub Actions
-
 ## v0.7.0
 - Enable asynchronous mode by default (#498)
 - No longer wrap user widgets starting with `autosuggest-` prefix (#496)

README.md

@@ -6,6 +6,7 @@ It suggests commands as you type based on history and completions.
 
 Requirements: Zsh v4.3.11 or later
 
+[![CircleCI](https://img.shields.io/circleci/build/github/zsh-users/zsh-autosuggestions.svg)](https://circleci.com/gh/zsh-users/zsh-autosuggestions)
 [![Chat on Gitter](https://img.shields.io/gitter/room/zsh-users/zsh-autosuggestions.svg)](https://gitter.im/zsh-users/zsh-autosuggestions)
 
 <a href="https://asciinema.org/a/37390" target="_blank"><img src="https://asciinema.org/a/37390.png" width="400" /></a>

VERSION

@@ -1 +1 @@
-v0.7.1
+v0.7.0

src/async.zsh

@@ -11,7 +11,7 @@ _zsh_autosuggest_async_request() {
 	# If we've got a pending request, cancel it
 	if [[ -n "$_ZSH_AUTOSUGGEST_ASYNC_FD" ]] && { true <&$_ZSH_AUTOSUGGEST_ASYNC_FD } 2>/dev/null; then
 		# Close the file descriptor and remove the handler
-		builtin exec {_ZSH_AUTOSUGGEST_ASYNC_FD}<&-
+		exec {_ZSH_AUTOSUGGEST_ASYNC_FD}<&-
 		zle -F $_ZSH_AUTOSUGGEST_ASYNC_FD
 
 		# We won't know the pid unless the user has zsh/system module installed
@@ -32,7 +32,7 @@ _zsh_autosuggest_async_request() {
 	fi
 
 	# Fork a process to fetch a suggestion and open a pipe to read from it
-	builtin exec {_ZSH_AUTOSUGGEST_ASYNC_FD}< <(
+	exec {_ZSH_AUTOSUGGEST_ASYNC_FD}< <(
 		# Tell parent process our pid
 		echo $sysparams[pid]
 
@@ -44,7 +44,6 @@ _zsh_autosuggest_async_request() {
 
 	# There's a weird bug here where ^C stops working unless we force a fork
 	# See https://github.com/zsh-users/zsh-autosuggestions/issues/364
-	autoload -Uz is-at-least
 	is-at-least 5.8 || command true
 
 	# Read the pid from the child process
@@ -65,13 +64,23 @@ _zsh_autosuggest_async_response() {
 	if [[ -z "$2" || "$2" == "hup" ]]; then
 		# Read everything from the fd and give it as a suggestion
 		IFS='' read -rd '' -u $1 suggestion
-		zle autosuggest-suggest -- "$suggestion"
+		_zsh_autosuggest_async_suggest "$suggestion"
 
 		# Close the fd
-		builtin exec {1}<&-
+		exec {1}<&-
 	fi
 
 	# Always remove the handler
 	zle -F "$1"
-	_ZSH_AUTOSUGGEST_ASYNC_FD=
+}
+
+_zsh_autosuggest_async_suggest() {
+	# Before 5.9, async suggestions break widgets that rely on LASTWIDGET
+	# such as copy-earlier-word and {up,down}-line-or-beginning-search. In
+	# 5.9, a flag was added to `zle` that will skip setting LASTWIDGET so
+	# that those widgets that depend on it will continue to work
+	# See https://www.zsh.org/mla/workers/2020/msg00824.html
+	local nolast
+	is-at-least 5.9 && nolast=supported
+	zle autosuggest-suggest ${=nolast:+-f nolast} -- "$1"
 }

src/config.zsh

@@ -28,8 +28,6 @@ typeset -g ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX=autosuggest-orig-
 		history-search-backward
 		history-beginning-search-forward
 		history-beginning-search-backward
-		history-beginning-search-forward-end
-		history-beginning-search-backward-end
 		history-substring-search-up
 		history-substring-search-down
 		up-line-or-beginning-search

src/widgets.zsh

@@ -30,7 +30,7 @@ _zsh_autosuggest_toggle() {
 # Clear the suggestion
 _zsh_autosuggest_clear() {
 	# Remove the suggestion
-	POSTDISPLAY=
+	unset POSTDISPLAY
 
 	_zsh_autosuggest_invoke_original_widget $@
 }
@@ -47,7 +47,7 @@ _zsh_autosuggest_modify() {
 	local orig_postdisplay="$POSTDISPLAY"
 
 	# Clear suggestion while waiting for next one
-	POSTDISPLAY=
+	unset POSTDISPLAY
 
 	# Original widget may modify the buffer
 	_zsh_autosuggest_invoke_original_widget $@
@@ -102,7 +102,7 @@ _zsh_autosuggest_suggest() {
 	if [[ -n "$suggestion" ]] && (( $#BUFFER )); then
 		POSTDISPLAY="${suggestion#$BUFFER}"
 	else
-		POSTDISPLAY=
+		unset POSTDISPLAY
 	fi
 }
 
@@ -128,7 +128,7 @@ _zsh_autosuggest_accept() {
 	BUFFER="$BUFFER$POSTDISPLAY"
 
 	# Remove the suggestion
-	POSTDISPLAY=
+	unset POSTDISPLAY
 
 	# Run the original widget before manually moving the cursor so that the
 	# cursor movement doesn't make the widget do something unexpected
@@ -151,7 +151,7 @@ _zsh_autosuggest_execute() {
 	BUFFER="$BUFFER$POSTDISPLAY"
 
 	# Remove the suggestion
-	POSTDISPLAY=
+	unset POSTDISPLAY
 
 	# Call the original `accept-line` to handle syntax highlighting or
 	# other potential custom behavior

zsh-autosuggestions.zsh

@@ -1,6 +1,6 @@
 # Fish-like fast/unobtrusive autosuggestions for zsh.
 # https://github.com/zsh-users/zsh-autosuggestions
-# v0.7.1
+# v0.7.0
 # Copyright (c) 2013 Thiago de Arruda
 # Copyright (c) 2016-2021 Eric Freese
 # 
@@ -54,8 +54,6 @@ typeset -g ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX=autosuggest-orig-
 		history-search-backward
 		history-beginning-search-forward
 		history-beginning-search-backward
-		history-beginning-search-forward-end
-		history-beginning-search-backward-end
 		history-substring-search-up
 		history-substring-search-down
 		up-line-or-beginning-search
@@ -294,7 +292,7 @@ _zsh_autosuggest_toggle() {
 # Clear the suggestion
 _zsh_autosuggest_clear() {
 	# Remove the suggestion
-	POSTDISPLAY=
+	unset POSTDISPLAY
 
 	_zsh_autosuggest_invoke_original_widget $@
 }
@@ -311,7 +309,7 @@ _zsh_autosuggest_modify() {
 	local orig_postdisplay="$POSTDISPLAY"
 
 	# Clear suggestion while waiting for next one
-	POSTDISPLAY=
+	unset POSTDISPLAY
 
 	# Original widget may modify the buffer
 	_zsh_autosuggest_invoke_original_widget $@
@@ -366,7 +364,7 @@ _zsh_autosuggest_suggest() {
 	if [[ -n "$suggestion" ]] && (( $#BUFFER )); then
 		POSTDISPLAY="${suggestion#$BUFFER}"
 	else
-		POSTDISPLAY=
+		unset POSTDISPLAY
 	fi
 }
 
@@ -392,7 +390,7 @@ _zsh_autosuggest_accept() {
 	BUFFER="$BUFFER$POSTDISPLAY"
 
 	# Remove the suggestion
-	POSTDISPLAY=
+	unset POSTDISPLAY
 
 	# Run the original widget before manually moving the cursor so that the
 	# cursor movement doesn't make the widget do something unexpected
@@ -415,7 +413,7 @@ _zsh_autosuggest_execute() {
 	BUFFER="$BUFFER$POSTDISPLAY"
 
 	# Remove the suggestion
-	POSTDISPLAY=
+	unset POSTDISPLAY
 
 	# Call the original `accept-line` to handle syntax highlighting or
 	# other potential custom behavior
@@ -768,7 +766,7 @@ _zsh_autosuggest_async_request() {
 	# If we've got a pending request, cancel it
 	if [[ -n "$_ZSH_AUTOSUGGEST_ASYNC_FD" ]] && { true <&$_ZSH_AUTOSUGGEST_ASYNC_FD } 2>/dev/null; then
 		# Close the file descriptor and remove the handler
-		builtin exec {_ZSH_AUTOSUGGEST_ASYNC_FD}<&-
+		exec {_ZSH_AUTOSUGGEST_ASYNC_FD}<&-
 		zle -F $_ZSH_AUTOSUGGEST_ASYNC_FD
 
 		# We won't know the pid unless the user has zsh/system module installed
@@ -789,7 +787,7 @@ _zsh_autosuggest_async_request() {
 	fi
 
 	# Fork a process to fetch a suggestion and open a pipe to read from it
-	builtin exec {_ZSH_AUTOSUGGEST_ASYNC_FD}< <(
+	exec {_ZSH_AUTOSUGGEST_ASYNC_FD}< <(
 		# Tell parent process our pid
 		echo $sysparams[pid]
 
@@ -801,7 +799,6 @@ _zsh_autosuggest_async_request() {
 
 	# There's a weird bug here where ^C stops working unless we force a fork
 	# See https://github.com/zsh-users/zsh-autosuggestions/issues/364
-	autoload -Uz is-at-least
 	is-at-least 5.8 || command true
 
 	# Read the pid from the child process
@@ -822,15 +819,25 @@ _zsh_autosuggest_async_response() {
 	if [[ -z "$2" || "$2" == "hup" ]]; then
 		# Read everything from the fd and give it as a suggestion
 		IFS='' read -rd '' -u $1 suggestion
-		zle autosuggest-suggest -- "$suggestion"
+		_zsh_autosuggest_async_suggest "$suggestion"
 
 		# Close the fd
-		builtin exec {1}<&-
+		exec {1}<&-
 	fi
 
 	# Always remove the handler
 	zle -F "$1"
-	_ZSH_AUTOSUGGEST_ASYNC_FD=
+}
+
+_zsh_autosuggest_async_suggest() {
+	# Before 5.9, async suggestions break widgets that rely on LASTWIDGET
+	# such as copy-earlier-word and {up,down}-line-or-beginning-search. In
+	# 5.9, a flag was added to `zle` that will skip setting LASTWIDGET so
+	# that those widgets that depend on it will continue to work
+	# See https://www.zsh.org/mla/workers/2020/msg00824.html
+	local nolast
+	is-at-least 5.9 && nolast=supported
+	zle autosuggest-suggest ${=nolast:+-f nolast} -- "$1"
 }
 
 #--------------------------------------------------------------------#