[Improvement] Defer sending doc changes to the agent to an idle timer.

copilot-emacs / copilot.el

An unofficial Copilot plugin for Emacs.

MIT License

1.79k stars 126 forks source link

[Improvement] Defer sending doc changes to the agent to an idle timer. #176

Open raymond-w-ko opened 1 year ago

raymond-w-ko commented 1 year ago

Currently, doc changes (like textDocument/didChange) are communicated on every change (essentially every key press). It would make more sense and improve responsiveness to defer communicating with the server until some idle time or until it is actually needed for a completion.

To implement this we don't have to reinvent the wheel and can just import most of it from the eglot implementation.

Implementation

Use a change queue to store doc changes.
Flush doc changes on idle timer.
Flush doc changes before making a completion request.
Don't send any pending events after the document has been closed or copilot mode has been disabled for a that buffer.

This fixes issue: https://github.com/zerolfx/copilot.el/issues/172 (although this is also seems to not be an issue in newer org versions).

raymond-w-ko commented 1 year ago

The original pull request would never have worked properly, since I thought nreverse reversed in place, but it was actually dropping the subsequent set of changes, meaning the buffer would have been desynced.

There is also some other extra stuff here, like the (copilot-resync-buffer) command, and a rewrite to fix save-* nesting order.

But assuming this is the wrong way to fix #172, there isn't anything too important here to merge.

emil-vdw commented 9 months ago

But assuming this is the wrong way to fix #172, there isn't anything too important here to merge.

@raymond-w-ko I am confused. does this PR fix the linked issue or not?

emil-vdw commented 7 months ago

I will push changes and get this merged.

emil-vdw commented 6 months ago

One last thing to check is that copilot-panel-complete also flushes pending messages before requesting completions.

emil-vdw commented 6 months ago

@timcharper Although I did manage to reproduce the problem initially I am also not seeing it anymore on Emacs 29.2 org mode version 9.6.15.

I do, however, feel like this is a good improvement nonetheless. That being deferring jsonrpc communication with the server to some idle time or until the user requests a completion (as implemented in and shamelessly stolen from eglot). This can still be "turned off" by setting the idle time low enough.

In any event, the PR title and description needs some work. I will update.