fix: race condition with new async renderer (#354)

* fix: race condition with new async renderer

Signed-off-by: Chapman Pendery <[email protected]>

* fix: use uuid as crypto is added in node 19

Signed-off-by: Chapman Pendery <[email protected]>

* fix: formatting

Signed-off-by: Chapman Pendery <[email protected]>

* ci: remove flakey tests

Signed-off-by: Chapman Pendery <[email protected]>

---------

Signed-off-by: Chapman Pendery <[email protected]>

Author: cpendery

.github/workflows/ci.yml

@@ -24,46 +24,8 @@ jobs:
 
       - run: npm run lint
 
-      - name: setup macOS shells
-        if: matrix.os == 'macos-latest'
-        shell: bash
-        run: |
-          brew install fish
-          brew install zsh
-          brew install nushell
-
-          git clone https://github.com/zsh-users/zsh-autosuggestions ~/.zsh/zsh-autosuggestions
-          echo "source ~/.zsh/zsh-autosuggestions/zsh-autosuggestions.zsh" > ~/.zshrc
-
-      - name: setup linux shells
-        if: matrix.os == 'ubuntu-latest'
-        shell: bash
-        run: |
-          sudo apt-add-repository ppa:fish-shell/release-3
-          sudo apt-get update
-          sudo apt install fish zsh
-          npm install -g nushell
-
-
-          git clone https://github.com/zsh-users/zsh-autosuggestions ~/.zsh/zsh-autosuggestions
-          echo "source ~/.zsh/zsh-autosuggestions/zsh-autosuggestions.zsh" > ~/.zshrc
-
-          sudo chmod -R 755 /usr/share/zsh/vendor-completions
-          sudo chown -R root:root /usr/share/zsh/vendor-completions
-          sudo chmod -R 755 /usr/share/zsh
-          sudo chown -R root:root /usr/share/zsh
-
-      - name: setup windows shells
-        if: matrix.os == 'windows-latest'
-        shell: pwsh
-        run: |
-          pipx install 'xonsh[full]'
-          choco install nushell
-
       - run: npm test
 
       - run: npm run build
 
       - run: npm link
-
-      - run: npm run test:e2e

package-lock.json

@@ -55,6 +55,7 @@
     "find-process": "^1.4.7",
     "strip-ansi": "^7.1.0",
     "toml": "^3.0.0",
+    "uuid": "^11.1.0",
     "wcwidth": "^1.0.1",
     "which": "^4.0.0",
     "wrap-ansi": "^8.1.0"

package.json

@@ -12,6 +12,7 @@ import isterm from "../isterm/index.js";
 import { resetToInitialState } from "../utils/ansi.js";
 import { SuggestionManager, MAX_LINES, KeyPressEvent } from "./suggestionManager.js";
 import { ISTerm } from "../isterm/pty.js";
+import { v4 as uuidV4 } from "uuid";
 
 export const renderConfirmation = (live: boolean): string => {
   const statusMessage = live ? chalk.green("live") : chalk.red("not found");
@@ -31,8 +32,8 @@ const _render = (term: ISTerm, suggestionManager: SuggestionManager, data: strin
   const suggestion = suggestionManager.render(direction);
   const hasSuggestion = suggestion.length != 0;
 
+  // there is no rendered suggestion and this will not render a suggestion
   if (!handlingSuggestion && !hasSuggestion) {
-    // there is no rendered suggestion and this will not render a suggestion
     writeOutput(data);
     return false;
   }
@@ -76,6 +77,7 @@ export const render = async (program: Command, shell: Shell, underTest: boolean,
   let hasSuggestion = false;
   let direction = _direction(term);
   let handlingBackspace = false; // backspace normally consistent of two data points (move back & delete), so on the first data point, we won't enforce the cursor terminated rule. this will help reduce flicker
+  let renderId = uuidV4();
   const stdinStartedInRawMode = process.stdin.isRaw;
   if (process.stdin.isTTY) process.stdin.setRawMode(true);
   readline.emitKeypressEvents(process.stdin);
@@ -89,13 +91,21 @@ export const render = async (program: Command, shell: Shell, underTest: boolean,
 
   term.onData(async (data) => {
     const handlingDirectionChange = direction != _direction(term);
+    // clear the previous suggestion if the direction has changed to avoid leftover suggestions
     if (handlingDirectionChange) {
       _clear(term);
     }
 
     hasSuggestion = _render(term, suggestionManager, data, handlingBackspace, hasSuggestion);
+
+    const currentRenderId = uuidV4();
+    renderId = currentRenderId;
     await suggestionManager.exec();
-    hasSuggestion = _render(term, suggestionManager, "", handlingBackspace, hasSuggestion);
+
+    // handle race conditions where a earlier render might override a later one
+    if (currentRenderId == renderId) {
+      hasSuggestion = _render(term, suggestionManager, "", handlingBackspace, hasSuggestion);
+    }
 
     handlingBackspace = false;
     direction = _direction(term);