75801bdb0e
* server/tab: Don't panic in `Pane::render`
and do not crash the application on failure to receive a render update
from plugins any longer. Instead, will print a simple string with a hint
to check the application logs, where a more thorough error indication
can be found.
* utils/errors: re-export `anyhow::Error`
to create ad-hoc errors with custom error types, without having to wrap
them into a `context()` before to turn the into anyhow errors.
* plugins: Check plugin version on startup
and terminate execution with a descriptive error message in case the
plugin version is incompatible with the version of zellij being run.
* server/wasm_vm: Add plugin path in version error
so the user knows which plugin to look at in case they're using custom
plugins.
* server/wasm_vm: Check plugin version for equality
Previously we would accept cases where the plugin version was newer than
the zellij version, which doesn't make a lot of sense.
* server/wasm_vm: Prettier error handling
in call to `wasmer::Function::call` in case a plugin version mismatch
can occur.
* tile: Install custom panic handler
that will print the panic message to a plugins stdout and then call a
panic handler on the host that turns it into a real application-level
panic.
* tile: Catch errors in event deserialization
and turn them into proper panics. These errors are symptomatic of an
uncaught plugin version mismatch, for example when developing from main
and compiling zellij/the plugins from source. Normal users should never
get to see this error.
* utils/errors: Improve output in `to_stdout`
for anyhow errors. The default anyhow error formatting of `{:?}` is
already very good, and we just made it worse by trying to invent our own
formatting.
* tile: Reword plugin mismatch error message
* zellij: Apply rustfmt
* changelog: Add PR #1838
Improve error handling on plugin version mismatch.
* server/wasm_vm: Rephrase error in passive voice
67 lines
1.9 KiB
Rust
67 lines
1.9 KiB
Rust
pub mod prelude;
|
|
pub mod shim;
|
|
|
|
use zellij_utils::data::Event;
|
|
|
|
#[allow(unused_variables)]
|
|
pub trait ZellijPlugin {
|
|
fn load(&mut self) {}
|
|
fn update(&mut self, event: Event) {}
|
|
fn render(&mut self, rows: usize, cols: usize) {}
|
|
}
|
|
|
|
pub const PLUGIN_MISMATCH: &str =
|
|
"An error occured in a plugin while receiving an Event from zellij. This means
|
|
that the plugins aren't compatible with the current zellij version.
|
|
|
|
The most likely explanation for this is that you're running either a
|
|
self-compiled zellij or plugin version. Please make sure that, while developing,
|
|
you also rebuild the plugins in order to pick up changes to the plugin code.
|
|
|
|
Please refer to the documentation for further information:
|
|
https://github.com/zellij-org/zellij/blob/main/CONTRIBUTING.md#building
|
|
";
|
|
|
|
#[macro_export]
|
|
macro_rules! register_plugin {
|
|
($t:ty) => {
|
|
thread_local! {
|
|
static STATE: std::cell::RefCell<$t> = std::cell::RefCell::new(Default::default());
|
|
}
|
|
|
|
fn main() {
|
|
// Register custom panic handler
|
|
std::panic::set_hook(Box::new(|info| {
|
|
report_panic(info);
|
|
}));
|
|
|
|
STATE.with(|state| {
|
|
state.borrow_mut().load();
|
|
});
|
|
}
|
|
|
|
#[no_mangle]
|
|
pub fn update() {
|
|
let object = $crate::shim::object_from_stdin()
|
|
.context($crate::PLUGIN_MISMATCH)
|
|
.to_stdout()
|
|
.unwrap();
|
|
|
|
STATE.with(|state| {
|
|
state.borrow_mut().update(object);
|
|
});
|
|
}
|
|
|
|
#[no_mangle]
|
|
pub fn render(rows: i32, cols: i32) {
|
|
STATE.with(|state| {
|
|
state.borrow_mut().render(rows as usize, cols as usize);
|
|
});
|
|
}
|
|
|
|
#[no_mangle]
|
|
pub fn plugin_version() {
|
|
println!("{}", $crate::prelude::VERSION);
|
|
}
|
|
};
|
|
}
|