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.

.circleci/config.yml

@@ -1,15 +0,0 @@
-version: 2
-jobs:
-  build:
-    parallelism: 4
-    shell: /bin/bash --login
-    docker:
-    - image: ericfreese/zsh-autosuggestions-test:latest
-    steps:
-    - checkout
-    - run:
-        name: Running tests
-        command: |
-          for v in $(grep "^[^#]" ZSH_VERSIONS | awk "(NR + $CIRCLE_NODE_INDEX) % $CIRCLE_NODE_TOTAL == 0"); do
-            TEST_ZSH_BIN=zsh-$v make test || exit 1
-          done

.github/workflows/integration.yml

@@ -0,0 +1,51 @@
+on: [push, pull_request]
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+env:
+  IMAGE_CACHE_PATH: /tmp/.image-cache
+  IMAGE_CACHE_NAME: zsh-autosuggestions-test
+jobs:
+  determine-versions:
+    runs-on: ubuntu-22.04
+    outputs:
+      versions: ${{ steps.set-versions.outputs.versions }}
+    steps:
+    - uses: actions/checkout@v3
+    - id: set-versions
+      run: |
+        echo "versions=$(
+          grep "^[^#]" ZSH_VERSIONS \
+          | sed -E 's/(^|$)/"/g' \
+          | paste -sd ',' - \
+          | sed -e 's/^/[/' -e 's/$/]/'
+        )" >> $GITHUB_OUTPUT
+  test:
+    needs: determine-versions
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        version: ${{ fromJson(needs.determine-versions.outputs.versions) }}
+    steps:
+    - uses: actions/checkout@v3
+    - name: Docker image cache
+      id: image-cache
+      uses: actions/cache@v3
+      with:
+        path: ${{ env.IMAGE_CACHE_PATH }}
+        key: image-cache-${{ matrix.version }}-${{ hashFiles('Dockerfile', 'install_test_zsh.sh', 'Gemfile.lock') }}
+    - name: Load cached docker image if available
+      if: ${{ steps.image-cache.outputs.cache-hit }}
+      run: gunzip < $IMAGE_CACHE_PATH/$IMAGE_CACHE_NAME.tar.gz | docker load
+    - name: Build the docker image if necessary
+      if: ${{ !steps.image-cache.outputs.cache-hit }}
+      run: |
+        docker build --build-arg TEST_ZSH_VERSION=${{ matrix.version }} -t $IMAGE_CACHE_NAME .
+        mkdir -p $IMAGE_CACHE_PATH
+        docker save $IMAGE_CACHE_NAME | gzip > $IMAGE_CACHE_PATH/$IMAGE_CACHE_NAME.tar.gz
+    - name: Run the tests
+      run: |
+        docker run --rm \
+          -v $PWD:/zsh-autosuggestions \
+          $IMAGE_CACHE_NAME \
+          make test

Dockerfile

@@ -1,5 +1,8 @@
 FROM ruby:2.5.3-alpine
 
+ARG TEST_ZSH_VERSION
+RUN : "${TEST_ZSH_VERSION:?}"
+
 RUN apk add --no-cache autoconf
 RUN apk add --no-cache libtool
 RUN apk add --no-cache libcap-dev
@@ -11,10 +14,8 @@ RUN apk add --no-cache tmux
 
 WORKDIR /zsh-autosuggestions
 
-ADD ZSH_VERSIONS /zsh-autosuggestions/ZSH_VERSIONS
+ADD install_test_zsh.sh ./
-ADD install_test_zsh.sh /zsh-autosuggestions/install_test_zsh.sh
 RUN ./install_test_zsh.sh
 
-ADD Gemfile /zsh-autosuggestions/Gemfile
+ADD Gemfile Gemfile.lock ./
-ADD Gemfile.lock /zsh-autosuggestions/Gemfile.lock
 RUN bundle install

README.md

@@ -170,18 +170,16 @@ Tests are written in ruby using the [`rspec`](http://rspec.info/) framework. The
 
 Test files live in `spec/`. To run the tests, run `make test`. To run a specific test, run `TESTS=spec/some_spec.rb make test`. You can also specify a `zsh` binary to use by setting the `TEST_ZSH_BIN` environment variable (ex: `TEST_ZSH_BIN=/bin/zsh make test`).
 
-A docker image for testing is available [on docker hub](https://hub.docker.com/r/ericfreese/zsh-autosuggestions-test). It comes with ruby, the bundler dependencies, and all supported versions of zsh installed.
+It's possible to run the tests for any supported version of zsh in a Docker image by building an image from the provided Dockerfile. To build the docker image for a specific version of zsh (where `<version>` below is substituted with the contents of a line from the [`ZSH_VERSIONS`](ZSH_VERSIONS) file), run:
-
-Pull the docker image with:
 
 ```sh
-docker pull ericfreese/zsh-autosuggestions-test
+docker build --build-arg TEST_ZSH_VERSION=<version> -t zsh-autosuggestions-test .
 ```
 
-To run the tests for a specific version of zsh (where `<version>` below is substituted with the contents of a line from the [`ZSH_VERSIONS`](ZSH_VERSIONS) file):
+After building the image, run the tests via:
 
 ```sh
-docker run -it -e TEST_ZSH_BIN=zsh-<version> -v $PWD:/zsh-autosuggestions zsh-autosuggestions-test make test
+docker run -it -v $PWD:/zsh-autosuggestions zsh-autosuggestions-test make test
 ```
 
 

ZSH_VERSIONS

@@ -1,9 +1,5 @@
 # Zsh releases to run tests against
 # See https://github.com/zsh-users/zsh/releases
-#
-# When modifying this file, rebuild and push docker image:
-#   $ docker build -t ericfreese/zsh-autosuggestions-test .
-#   $ docker push ericfreese/zsh-autosuggestions-test
 4.3.11
 5.0.2
 5.0.8
@@ -14,4 +10,5 @@
 5.5.1
 5.6.2
 5.7.1
-5.8
+5.8.1
+5.9

install_test_zsh.sh

@@ -2,25 +2,22 @@
 
 set -ex
 
-for v in $(grep "^[^#]" ZSH_VERSIONS); do
+mkdir zsh-build
-  mkdir zsh-$v
+cd zsh-build
-  cd zsh-$v
 
-  curl -L https://api.github.com/repos/zsh-users/zsh/tarball/zsh-$v | tar xz --strip=1
+curl -L https://api.github.com/repos/zsh-users/zsh/tarball/zsh-$TEST_ZSH_VERSION | tar xz --strip=1
 
-  ./Util/preconfig
+./Util/preconfig
-  ./configure --enable-pcre \
+./configure --enable-pcre \
-              --enable-cap \
+            --enable-cap \
-              --enable-multibyte \
+            --enable-multibyte \
-              --with-term-lib='ncursesw tinfo' \
+            --with-term-lib='ncursesw tinfo' \
-              --with-tcsetpgrp \
+            --with-tcsetpgrp
-              --program-suffix="-$v"
 
-  make install.bin
+make install.bin
-  make install.modules
+make install.modules
-  make install.fns
+make install.fns
 
-  cd ..
+cd ..
 
-  rm -rf zsh-$v
+rm -rf zsh-build
-done

src/async.zsh

@@ -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,7 +64,7 @@ _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
 		exec {1}<&-
@@ -74,3 +73,14 @@ _zsh_autosuggest_async_response() {
 	# Always remove the handler
 	zle -F "$1"
 }
+
+_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"
+}

zsh-autosuggestions.zsh

@@ -799,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
@@ -820,7 +819,7 @@ _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
 		exec {1}<&-
@@ -830,6 +829,17 @@ _zsh_autosuggest_async_response() {
 	zle -F "$1"
 }
 
+_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"
+}
+
 #--------------------------------------------------------------------#
 # Start                                                              #
 #--------------------------------------------------------------------#