feat: new relay-notify-push DDS event to allow custom notification handlers (#3642)

Author: sxyazi

CHANGELOG.md

@@ -15,6 +15,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/):
 ### Added
 
 - Allow using `ps.sub()` in `init.lua` directly without a plugin ([#3638])
+- New `relay-notify-push` DDS event to allow custom notification handlers ([#3642])
 - New `cx.which` API to access the which component state ([#3617])
 - New `ind-which-activate` DDS event to change the which component behavior ([#3608])
 
@@ -1636,3 +1637,4 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/):
 [#3633]: https://github.com/sxyazi/yazi/pull/3633
 [#3634]: https://github.com/sxyazi/yazi/pull/3634
 [#3638]: https://github.com/sxyazi/yazi/pull/3638
+[#3642]: https://github.com/sxyazi/yazi/pull/3642

Cargo.lock

@@ -35,6 +35,7 @@ core-foundation-sys = "0.8.7"
 crossterm           = { version = "0.29.0", features = [ "event-stream" ] }
 dirs                = "6.0.0"
 dyn-clone           = "1.0.20"
+either              = { version = "1.15.0", features = [ "serde" ] }
 foldhash            = "0.2.0"
 futures             = "0.3.31"
 globset             = "0.4.18"

Cargo.toml

@@ -38,6 +38,7 @@ yazi-widgets   = { path = "../yazi-widgets", version = "26.1.22" }
 # External dependencies
 anyhow       = { workspace = true }
 crossterm    = { workspace = true }
+either       = { workspace = true }
 futures      = { workspace = true }
 hashbrown    = { workspace = true }
 mlua         = { workspace = true }

yazi-actor/Cargo.toml

@@ -2,7 +2,7 @@ use anyhow::Result;
 use mlua::IntoLua;
 use tracing::error;
 use yazi_actor::lives::Lives;
-use yazi_binding::runtime_mut;
+use yazi_binding::runtime_scope;
 use yazi_dds::{LOCAL, Payload, REMOTE};
 use yazi_macro::succ;
 use yazi_plugin::LUA;
@@ -31,11 +31,9 @@ impl Actor for AcceptPayload {
 		succ!(Lives::scope(&cx.core, || {
 			let body = payload.body.into_lua(&LUA)?;
 			for (id, cb) in handlers {
-				let blocking = runtime_mut!(LUA)?.critical_push(&id, true);
-				if let Err(e) = cb.call::<()>(body.clone()) {
+				if let Err(e) = runtime_scope!(LUA, &id, cb.call::<()>(body.clone())) {
 					error!("Failed to run `{kind}` event handler in your `{id}` plugin: {e}");
 				}
-				runtime_mut!(LUA)?.critical_pop(blocking)?;
 			}
 			Ok(())
 		})?);

yazi-actor/src/app/accept_payload.rs

@@ -3,6 +3,7 @@ use crossterm::event::MouseEventKind;
 use mlua::{ObjectLike, Table};
 use tracing::error;
 use yazi_actor::lives::Lives;
+use yazi_binding::runtime_scope;
 use yazi_config::YAZI;
 use yazi_macro::succ;
 use yazi_parser::app::MouseOpt;
@@ -20,11 +21,14 @@ impl Actor for Mouse {
 
 	fn act(cx: &mut Ctx, opt: Self::Options) -> Result<Data> {
 		let event = yazi_binding::MouseEvent::from(opt.event);
+
 		let Some(size) = cx.term.as_ref().and_then(|t| t.size().ok()) else { succ!() };
+		let area = yazi_binding::elements::Rect::from(size);
 
 		let result = Lives::scope(&cx.core, move || {
-			let area = yazi_binding::elements::Rect::from(size);
-			let root = LUA.globals().raw_get::<Table>("Root")?.call_method::<Table>("new", area)?;
+			let root = runtime_scope!(LUA, "root", {
+				LUA.globals().raw_get::<Table>("Root")?.call_method::<Table>("new", area)
+			})?;
 
 			if matches!(event.kind, MouseEventKind::Down(_) if YAZI.mgr.mouse_events.get().draggable()) {
 				root.raw_set("_drag_start", event)?;

yazi-actor/src/app/mouse.rs

@@ -1,6 +1,6 @@
 use anyhow::Result;
 use mlua::{ErrorContext, ExternalError, IntoLua, Value};
-use yazi_binding::runtime_mut;
+use yazi_binding::runtime_scope;
 use yazi_dds::{LOCAL, spark::{Spark, SparkKind}};
 use yazi_plugin::LUA;
 
@@ -18,11 +18,7 @@ impl Preflight {
 		Ok(Lives::scope(cx.core, || {
 			let mut body = opt.1.into_lua(&LUA)?;
 			for (id, cb) in handlers {
-				let blocking = runtime_mut!(LUA)?.critical_push(&id, true);
-				let result = cb.call::<Value>(&body);
-				runtime_mut!(LUA)?.critical_pop(blocking)?;
-
-				match result {
+				match runtime_scope!(LUA, &id, cb.call::<Value>(&body)) {
 					Ok(Value::Nil) => {
 						Err(format!("`{kind}` event cancelled by `{id}` plugin on preflight").into_lua_err())?
 					}

yazi-actor/src/core/preflight.rs

@@ -16,7 +16,10 @@ pub(super) static FILE_CACHE: RoCell<RefCell<HashMap<PtrCell<yazi_fs::File>, Any
 pub struct Lives;
 
 impl Lives {
-	pub fn scope<T>(core: &yazi_core::Core, f: impl FnOnce() -> mlua::Result<T>) -> mlua::Result<T> {
+	pub fn scope<T, F>(core: &yazi_core::Core, f: F) -> mlua::Result<T>
+	where
+		F: FnOnce() -> mlua::Result<T>,
+	{
 		FILE_CACHE.init(Default::default());
 		defer! { FILE_CACHE.drop(); }
 

yazi-actor/src/lives/lives.rs

@@ -14,7 +14,7 @@ impl Actor for ToggleAll {
 	const NAME: &str = "toggle_all";
 
 	fn act(cx: &mut Ctx, opt: Self::Options) -> Result<Data> {
-		use yazi_shared::Either::*;
+		use either::Either::*;
 		let tab = cx.tab_mut();
 
 		let it = tab.current.files.iter().map(|f| &f.url);

yazi-actor/src/mgr/toggle_all.rs

@@ -1,11 +1,11 @@
-use std::time::{Duration, Instant};
+use std::time::Instant;
 
 use anyhow::Result;
 use yazi_core::notify::Message;
-use yazi_macro::succ;
+use yazi_dds::spark::SparkKind;
+use yazi_macro::{act, succ};
 use yazi_parser::notify::PushOpt;
-use yazi_proxy::NotifyProxy;
-use yazi_shared::data::Data;
+use yazi_shared::{Source, data::Data};
 
 use crate::{Actor, Ctx};
 
@@ -24,8 +24,15 @@ impl Actor for Push {
 
 		if cx.notify.messages.iter().all(|m| m != &msg) {
 			cx.notify.messages.push(msg);
-			NotifyProxy::tick(Duration::ZERO);
+			act!(notify:tick, cx)?;
 		}
 		succ!();
 	}
+
+	fn hook(cx: &Ctx, _: &Self::Options) -> Option<SparkKind> {
+		match cx.source() {
+			Source::Relay => Some(SparkKind::RelayNotifyPush),
+			_ => None,
+		}
+	}
 }