vscode: Overriding the default 'type' command and then calling the default 'type' command results in significantly slower execution time
- VSCode Version: 1.27.1
- OS Version: Windows 10 1809
- Machine processor: AMD A8-4555M APU Quad core clocked at 1.6GHz
- Graphics card: AMD Radeon HD 7600G
Does this issue occur when all extensions are disabled?: Yes (Aside from VSCodeVim - where the potential problem in the extensions API has been detected)
Steps to Reproduce:
- Override the ‘type’ command with
vscode.commands.registerCommand - Call the default ‘type’ command instead of the custom command
- Note the difference in execution time in calling
vscode.commands.executeCommand('type', ...)when no custom type command has been registered, vs. callingvscode.commands.executeCommand('default: type', ...)(when a custom command has been registered/is overriding the default ‘type’ command). On my machine, the difference in execution time is consistently an order of magnitude (roughly 20ms vs 200ms) larger every time the executeCommand(‘default: type’, …) is called after overriding.
I have included some of my machine details here just-in-case - although I do doubt that they play any part in the issue here.
One of VSCode’s most popular plugins, VSCodeVim/Vim, has an issue experienced by a fair share of the VSCodeVim community, as can be seen in an issue raised over a year ago in their repo - VSCodeVim/Vim#2021. Typing in an editor window whilst this plugin is enabled results in an unbearably slow character render time, for a range of slower (and perhaps sometimes slighty-faster-than-slow) machines. During a screen-share a little while ago with @shawnaxsom, a contributor to the VSCodeVim community, we boiled the problem down to the ‘type’ command being overridden, and then having the default type command executed afterwards. For example, from my understanding of the VSCodeVim extension, the ‘type’ command is overridden like so:
vscode.commands.registerCommand('type', async ...
The default ‘type’ command is then called when needed, with code like this:
await vscode.commands.executeCommand('default:type', { text });
We measured the time taken for an ordinary (non-overridden) execution of the type command (which was roughly 20ms on my machine), vs. then calling ‘default: type’ command, which was always roughly 10x slower. Even though I am not familiar with the extensions API, this is puzzling, since these two calls should be doing exactly the same thing, yet calling executeCommand('default: type', ...) results in a much slower execution time of the default type command. I guess it has been an assumption that the source code in the VSCodeVim extension has been responsible for the severe typing slowness (or, it has only been occurring on slow machines, since it does not occur for everyone using the extension), but our screenshare led us to the conclusion that it appears to be this part of the extensions API which seems to be responsible. I imagine, also, that the much-slower execution time also occurs on faster machines, but it is simply not noticeable due to the fact that the faster processing/graphical power prevents the comparably slower call to the ‘type’ command being made visible rendering-wise. Even though it shouldn’t matter, It is perhaps worth mentioning too, that even if the overridden (type) command is doing minimal work, as far as I know (I think we also tested this), the significant execution time difference still occurs.
About this issue
- Original URL
- State: open
- Created 6 years ago
- Reactions: 95
- Comments: 16 (7 by maintainers)
Commits related to this issue
- Preparation for running extension in nodeless environment (#4981) VS Code is adding support for running extensions in a nodeless environment. This PR tries to refactor the code a bit to allow later o... — committed to VSCodeVim/Vim by rebornix 4 years ago
- VSCode: Use a dedicated process for Vim See here: https://github.com/microsoft/vscode/issues/65876#issuecomment-1078827200 > You can double check that vim is loaded in a separate process using F1 > ... — committed to gabebw/dotfiles by gabebw 2 years ago
In our latest Insiders Build, we have added a new experimental setting that would allow to execute the vim extension in a dedicated extension host process.
Configure the following in your
settings.jsonand then reload window or restart:You can double check that vim is loaded in a separate process using
F1 > Developer: Show Running Extensions:The number of thumbs up on this issue is deceptive. It’s the second most highly upvoted issue for VSCodeVim: https://github.com/VSCodeVim/Vim/issues/2021
This particular issue is affecting many extensions. Those of us who like the excellent auto-completion on vscode and the powerful features of a modal editor like vim find this a deal breaker 😦
Please give this issue some love ❤️ Thanks!
Is there anything I can do to assist with this?
I apologise profusely for letting this issue go dead by not responding a couple of months ago; I had a prolonged emergency situation and never got round to testing and reporting back on the effects of the provided minimal extension. I was reminded by the issue reference yesterday and have got round to trying it out.
Big surprise. The simple extension provided incurs very-almost the same performance penalty as VSCodeVim (with Vim and all other extensions disabled, of course). This came as a shock to me, because I did think that perhaps it was VSCodeVim after all. I have made extra sure that there is nothing else interfering. The basic ‘hello world’ predictably has no effect on typing, but simply adding the few lines of code to override the type command and execute the default type command within, has a very large effect on rendering/performance. As you say @alexandrudima, it is perhaps due to the frame being missed and the rendering occurring at the next frame.
I have not attempted to apply the diff to vscode for measuring typing (rendering) latency via going through the extension host; if this would be helpful, I could report back on this. Unremarkably, too, the measured extension host latency is around 2-3ms. Quite the shock indeed… if there is anything I can do to assist and test, please do let me know.
@JuanQuiro Hi, Jump’s author here, you can paste the following config into your VSCode
settings.json:I was curious to dig a bit deeper. The larger times are mostly because the frame is missed and the painting occurs at the next frame (and the times above measure the elapsed time from keypress until the paint occurs), not due to latency. To validate this, I have built an action that tests the latency of going to the extension host process, as well as the throughput. It will come out with tomorrow’s insiders
e.g.
Developer: Measure Extension Host LatencyFWIW:
settings.jsondidn’t seem to remove it — changing the vim extensions’ settings insettings.jsondidn’t seem to impact its behavior. I was still seeing output inOutput -> Windowthat vim was in a different process after running “Reload Window” (also after quitting and restarting VS Code)~/Library/Application Support/Code, which then took a while to restore settingsSo — I wouldn’t recommend trying this unless you really need it.
If this is wrong, very happy to be corrected by someone knowledgeable about the code — clearly one person having a bad experience shouldn’t be weighed that much.
@samueltlg I also wondered what is the overhead of going through the extension host for typing, so I applied the following diff to vscode to measure it:
Please note that the rendering occurs at the next animation frame, so it is delayed until Electron considers it would be a good idea for us to render, i.e. the times below do not indicate the time it takes to interpret the typing, but indicate the elapsed time from when the keydown was first received until a line was painted:
Although non-negligible, the latency of going to the extension host process and back is somewhere in the 10-15ms ballpark, which is still fast enough to make typing feel buttery smooth.
TL;DR I don’t think there is an issue with VS Code here…