Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clipboard: Read channel id from nvim variable #1411

Merged
merged 1 commit into from Jul 22, 2022

Conversation

khjorth
Copy link
Contributor

@khjorth khjorth commented Jul 20, 2022

Clipboard providers are only loaded once by Neovim, causing the previous code to use an obsolete channel id when reconnecting to a remote nvim instance.

Fixes #1329.

What kind of change does this PR introduce?

  • Fix

Did this PR introduce a breaking change?

A breaking change includes anything that breaks backwards compatibility either at compile or run time.
I hope not.

[Clipboard providers are only loaded once by Neovim](neovim/neovim#8017), causing the previous code to use an obsolete channel id when reconnecting to a remote nvim instance.
@khjorth khjorth marked this pull request as ready for review July 20, 2022 21:06
Copy link
Contributor

@MultisampledNight MultisampledNight left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! Only a small question.

.replace('\n', "") // make one-liner, because multiline is not accepted (?)
.replace("neovide_channel", &neovide_channel.to_string());
nvim.command(&custom_clipboard).await.ok();
nvim.set_var("neovide_channel_id", Value::from(neovide_channel))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you set this var, shouldn't it be removed after executing the Lua code? Else someone could stumble across this and potentially rely on an outdated value.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately, that won't work, since the variable is read whenever the + and * registers are accessed. Reading the channel from a variable allows us to use the same clipboard provider across multiple UI sessions.

Else someone could stumble across this and potentially rely on an outdated value.

A session has only one channel id in its lifetime, and the variable is updated whenever Neovide attaches to nvim, so this shouldn't be too much of an issue. (Unless the user starts multiple overlapping sessions, but we don't seem to support that at all).

While I'm generally strongly in favor of data encapsulation, having the channel id in a global variable makes debugging of channel issues a lot easier.

An alternative approach is to forcibly reload the clipboard provider whenever Neovide attaches to nvim. We might need something like that in order to fix #1331. This could also make it possible to mix different UI clients without breaking the clipboard. The drawbacks are that this seems like a hack, and it might break things for users who rely on the clipboard provider being loaded only once. I think the best approach is to make forcible reloading optional (can be disabled by setting a variable) and combining it with the present solution.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a good idea, thanks for the extended explanation!

@MultisampledNight MultisampledNight merged commit d8efc9a into neovide:main Jul 22, 2022
@MultisampledNight
Copy link
Contributor

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clipboard breaks after reconnecting to remote nvim instance
2 participants