Cursor moved during typing

[guoh27]

Describe the bug
Cursor moved during typing

To Reproduce
Steps to reproduce the behavior:

1. Go to .bb recipe text.
2. Typing something
3. Cursor was moved

Desktop (please complete the following information):

• OS: Windows
• VS Code version 1.97.2
• Extension version 2.8.0
• Yocto Version 4.0
• Other affected software version when applicable (CMake, SSH, kas, ...)

[deribaucourt]

Hello, thank you for your feedback!

I couldn't reproduce a jumpy cursor when editing a .bb. Maybe it only appears in specific conditions?
Could you provide a screen recording of the bug happening, along with an affected .bb file?
Do you think this only happens on specific sections of the text file?

[jrmejiaa]

I have the same behavior since the last update. For me it happens when I was trying to change something from a python task.

[deribaucourt]

Indeed I was able to reproduce this, but it's not systematic.

1. open file poky/meta/classes/baremetal-image.bbclass
2. Save it and run a recipe scan (global env)
3. Type something at the end of the file
4. Type something in do_rootfs()
5. Click quickly everywhere and type around the file
6. The cursor may jump to a previous location (the same several times)

We'll investigate this further. May be due to a new way vscode handles tab transitions, or some of the companion extensions (bash-ide, python, shellcheck). bash-ide has not been updated recently, so that's not the issue. Disabling shellcheck slightly improves responsiveness but the bug is still present. So it's likely within our tab management that broke. Downgrading this extension to 2.7 did not solve the issue. I reproduced the same with code v1.92.2 which is 6 months dated. I'd say it's a random issue that we may have had for some time apparently. We should bring up the debugger and see if it's linked to bash or python specifically. It looks like we remember a cursor position and a race condition replays an event to teleport there even though its outdated and we forgot to clean it up.

TEMPORARY WORKAROUND (Outdated, a better one is presented bellow)

I was able to figure it is linked to our "embedded languages files feature". As a workaround, you can disable this feature through the setting bitbake.disableEmbeddedLanguagesFiles. You'll lose some features within the bash/python sections like go to definition and error highlights.

[guoh27]

Recording_1.mp4

Any text of bitbake edit could happened

[deribaucourt]

Yes, with additional testing, it also requires to parse the file once.
Using breakpoints, happens at updateEmbeddedLanguageDocFile await document.save()

[struers-cge]

I'm having the exact same issue. Cursor jumps randomly on typing/pasting/new-line. Disabling the extension removes the issue.

[deribaucourt]

I found an interference with another extension: EditorConfig.EditorConfig since v1.17.0.
Depending on the .editorconfig (or default settings), it may try to override settings like "files.trimTrailingWhitespace": false which we need to enforce to translate between the .bb and .sh/.py background files.

Disable the EditorConfig extension or Downgrade it to 1.16.7

For now, you can disable that extension and implement the file formatting parameters through the VSCode settings. Further investigation will be needed to make this extension and the EditorConfig compatible by cross-debugging both code bases.

Thanks @idillon-sfl for testing on your side

[deribaucourt]

Probably linked to:

• Jumping cursor with Auto Save: afterDelay editorconfig/editorconfig-vscode#408
• editorconfig/editorconfig-vscode@9f87be5
• editorconfig/editorconfig-vscode@4c8b3a0
• editorconfig/editorconfig-vscode@main...delay-newline

For our embedded languages features, we apply vscode edits behind the scene in temporary background tabs that we edit/save/close. The way the editorconfig extension also tries to apply edit when we save those background files is likely mixing cursor positions.

Apparently EditorConfig extension v1.17 broke other tools like:

• Broken navigation with VSCode VIM editorconfig/editorconfig-vscode#407
• [cursor movement] press escape will jump to previous position VSCodeVim/Vim#8624
• Jumping cursor with Auto Save: afterDelay editorconfig/editorconfig-vscode#408
  v1.17.1 could fix this on its own.

[deribaucourt]

Tested with EditorConfig extension branch delay-newline which fixed the issue.
Awaiting an official release of it and testing again before closing this issue.

[deribaucourt]

EditorConfig extension v1.17.1 was just released. I tested it on my side and it fixed the bug.
Please update that extension.
Closing this issue.
Thanks to all users who participated in this discussion, and the EditorConfig team for their swift fix.