xtermjs/xterm.js

Current search index changing when new lines are written

Open

#3,886 opened on Jul 5, 2022

View on GitHub
 (7 comments) (0 reactions) (0 assignees)TypeScript (16,196 stars) (1,574 forks)batch import
area/addon/searchhelp wantedtype/bug

Description

I began using the search addon to benefit from the newly implemented onDidChangeResults which allows us to get the currently highlighted match out of the total number of matches. The only thing that I'm wondering is why this line is being called as it causes this behaviour:

https://user-images.githubusercontent.com/10833491/177368718-63a0f761-02dd-441f-a6a7-fd2021282ef0.mov

For context I'm watching a stress-test Docker container which writes a lot of new lines and I'm pressing the Enter key which calls the search addon's findNext method. With that line, the current index get constantly overwritten with the total size of results? I'm a bit confused if I'm doing something wrong, if adding lines in the middle of a search might break this? Let me know if you need more information.

Details

  • Browser and browser version: Electron 17.2.0
  • OS version: macOS Monterey 12.4
  • xterm.js version: 4.19.0

Steps to reproduce

Created a sandbox to demonstrate what I'm saying. Even though the findNext is correctly highlighting the next match, the X of Y is constantly incorrect.

Contributor guide

Tech stack
typescript
Domain
frontendsearch
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScriptxterm.jssearch addon
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Investigate the behavior of the search addon when new lines are added to the terminal. Look at the code in SearchAddon.ts, especially the method that calls the line referenced in the issue. Determine why the current index is being reset to the total number of matches, and propose a fix to preserve the current match index when new lines are appended.
Current search index changing when new lines are written · xtermjs/xterm.js#3886 | Good First Issue