prototype - working with message from the cli

zellij-org · imsnif · Jan 17, 2024 · Dec 3, 2023 · Dec 5, 2023 · Dec 5, 2023
commit c755ab31fbb57d4167063a9d2a6d02a231a670db
diff --git a/zellij-server/src/plugins/mod.rs b/zellij-server/src/plugins/mod.rs
@@ -100,6  100,8 @@ pub enum PluginInstruction {
     ),
     DumpLayout(SessionLayoutMetadata, ClientId),
     LogLayoutToHd(SessionLayoutMetadata),
     SubscribePluginToCustomMessage(PluginId, ClientId, String), // String -> custom message name
     Message(String, String, ClientId), // Strings -> name, payload
     Exit,
 }
 
@@ -131,6  133,8 @@ impl From<&PluginInstruction> for PluginContext {
             },
             PluginInstruction::DumpLayout(..) => PluginContext::DumpLayout,
             PluginInstruction::LogLayoutToHd(..) => PluginContext::LogLayoutToHd,
             PluginInstruction::SubscribePluginToCustomMessage(..) => PluginContext::SubscribePluginToCustomMessage,
             PluginInstruction::Message(..) => PluginContext::Message,
         }
     }
 }
@@ -171,6  175,8 @@ pub(crate) fn plugin_thread_main(
         layout.clone(),
     );
 
     let mut plugin_custom_message_subscriptions: HashMap<(PluginId, ClientId), HashSet<String>> = HashMap::new();
 
     loop {
         let (event, mut err_ctx) = bus.recv().expect("failed to receive event on channel");
         err_ctx.add_call(ContextType::Plugin((&event).into()));
@@ -398,6  404,30 @@ pub(crate) fn plugin_thread_main(
                         .send_to_pty(PtyInstruction::LogLayoutToHd(session_layout_metadata)),
                 );
             },
             PluginInstruction::SubscribePluginToCustomMessage(plugin_id, client_id, custom_message_name) => {
                 plugin_custom_message_subscriptions.entry((plugin_id, client_id)).or_insert_with(HashSet::new).insert(custom_message_name);
             },
             PluginInstruction::Message(name, payload, client_id) => { // TODO: remove client_id,
                                                                       // it's from the cli
                 let mut updates = vec![];
                 let mut found = false;
                 for ((plugin_id, client_id), subscriptions) in &plugin_custom_message_subscriptions {
                     if subscriptions.contains(&name) {
                         found = true;
                         updates.push((Some(*plugin_id), Some(*client_id), Event::CustomMessage(name.clone(), payload.clone())));
                     }
 
                 }
                 wasm_bridge.update_plugins(updates, shutdown_send.clone())?;
                 if !found {
                     // TODO: send an error back to the cli or wherever
 
                 }
                 let _ = bus
                     .senders
                     .send_to_server(ServerInstruction::UnblockInputThread)
                     .context("failed to unblock input");
             },
             PluginInstruction::Exit => {
                 break;
             },

diff --git a/zellij-server/src/plugins/wasm_bridge.rs b/zellij-server/src/plugins/wasm_bridge.rs
@@ -410,42  410,47 @@ impl WasmBridge {
                         let mut running_plugin = running_plugin.lock().unwrap();
                         let _s = _s; // guard to allow the task to complete before cleanup/shutdown
                         if running_plugin.apply_event_id(AtomicEvent::Resize, event_id) {
                             let old_rows = running_plugin.rows;
                             let old_columns = running_plugin.columns;
                             running_plugin.rows = new_rows;
                             running_plugin.columns = new_columns;
 
-                            let rendered_bytes = running_plugin
-                                .instance
-                                .clone()
-                                .exports
-                                .get_function("render")
-                                .map_err(anyError::new)
-                                .and_then(|render| {
-                                    render
-                                        .call(
-                                            &mut running_plugin.store,
-                                            &[
-                                                Value::I32(new_rows as i32),
-                                                Value::I32(new_columns as i32),
-                                            ],
-                                        )
-                                        .map_err(anyError::new)
-                                })
-                                .and_then(|_| wasi_read_string(&running_plugin.plugin_env.wasi_env))
-                                .with_context(err_context);
-                            match rendered_bytes {
-                                Ok(rendered_bytes) => {
-                                    let plugin_bytes = vec![(
-                                        plugin_id,
-                                        client_id,
-                                        rendered_bytes.as_bytes().to_vec(),
-                                    )];
-                                    senders
-                                        .send_to_screen(ScreenInstruction::PluginBytes(
-                                            plugin_bytes,
-                                        ))
-                                        .unwrap();
-                                },
-                                Err(e) => log::error!("{}", e),
                             // TODO: better, right now the plugin doesn't render on first render?
                             if old_rows != new_rows || old_columns != new_columns {
                                 let rendered_bytes = running_plugin
                                     .instance
                                     .clone()
                                     .exports
                                     .get_function("render")
                                     .map_err(anyError::new)
                                     .and_then(|render| {
                                         render
                                             .call(
                                                 &mut running_plugin.store,
                                                 &[
                                                     Value::I32(new_rows as i32),
                                                     Value::I32(new_columns as i32),
                                                 ],
                                             )
                                             .map_err(anyError::new)
                                     })
                                     .and_then(|_| wasi_read_string(&running_plugin.plugin_env.wasi_env))
                                     .with_context(err_context);
                                 match rendered_bytes {
                                     Ok(rendered_bytes) => {
                                         let plugin_bytes = vec![(
                                             plugin_id,
                                             client_id,
                                             rendered_bytes.as_bytes().to_vec(),
                                         )];
                                         senders
                                             .send_to_screen(ScreenInstruction::PluginBytes(
                                                 plugin_bytes,
                                             ))
                                             .unwrap();
                                     },
                                     Err(e) => log::error!("{}", e),
                                 }
                             }
                         }
                     }

diff --git a/zellij-server/src/plugins/zellij_exports.rs b/zellij-server/src/plugins/zellij_exports.rs
@@ -240,6  240,9 @@ fn host_run_plugin_command(env: FunctionEnvMut<ForeignFunctionEnv>) {
                     PluginCommand::RenameSession(new_session_name) => {
                         rename_session(env, new_session_name)
                     },
                     PluginCommand::SubscribeToCustomMessage(custom_message_name) => {
                         subscribe_to_custom_message(env, custom_message_name)?
                     },
                 },
                 (PermissionStatus::Denied, permission) => {
                     log::error!(
@@ -272,6  275,17 @@ fn subscribe(env: &ForeignFunctionEnv, event_list: HashSet<EventType>) -> Result
         ))
 }
 
 // TODO: permissions!!!111oneoneone
 fn subscribe_to_custom_message(env: &ForeignFunctionEnv, custom_message_name: String) -> Result<()> {
     env.plugin_env
         .senders
         .send_to_plugin(PluginInstruction::SubscribePluginToCustomMessage(
             env.plugin_env.plugin_id,
             env.plugin_env.client_id,
             custom_message_name,
         ))
 }
 
 fn unsubscribe(env: &ForeignFunctionEnv, event_list: HashSet<EventType>) -> Result<()> {
     env.subscriptions
         .lock()

diff --git a/zellij-server/src/route.rs b/zellij-server/src/route.rs
@@ -803,6  803,12 @@ pub(crate) fn route_action(
                 .send_to_screen(ScreenInstruction::RenameSession(name, client_id))
                 .with_context(err_context)?;
         },
         Action::Message(name, payload) => {
             log::info!("Action::Message");
             senders
                 .send_to_plugin(PluginInstruction::Message(name, payload, client_id))
                 .with_context(err_context)?;
         },
     }
     Ok(should_break)
 }

diff --git a/zellij-tile/src/shim.rs b/zellij-tile/src/shim.rs
@@ -694,6  694,14 @@ pub fn rename_session(name: &str) {
     unsafe { host_run_plugin_command() };
 }
 
 /// Allow sending this plugin custom messages with the given name
 pub fn subscribe_to_custom_message(name: &str) {
     let plugin_command = PluginCommand::SubscribeToCustomMessage(name.to_owned());
     let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap();
     object_to_stdout(&protobuf_plugin_command.encode_to_vec());
     unsafe { host_run_plugin_command() };
 }
 
 // Utility Functions
 
 #[allow(unused)]

diff --git a/zellij-utils/assets/prost/api.action.rs b/zellij-utils/assets/prost/api.action.rs
@@ -5,7  5,7 @@ pub struct Action {
     pub name: i32,
     #[prost(
         oneof = "action::OptionalPayload",
-        tags = "2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46"
         tags = "2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47"
     )]
     pub optional_payload: ::core::option::Option<action::OptionalPayload>,
 }
@@ -104,6  104,8 @@ pub mod action {
         RenameSessionPayload(::prost::alloc::string::String),
         #[prost(message, tag = "46")]
         LaunchPluginPayload(super::LaunchOrFocusPluginPayload),
         #[prost(message, tag = "47")]
         MessagePayload(super::NameAndValue),
     }
 }
 #[allow(clippy::derive_partial_eq_without_eq)]
@@ -410,6  412,7 @@ pub enum ActionName {
     BreakPaneLeft = 79,
     RenameSession = 80,
     LaunchPlugin = 81,
     Message = 82,
 }
 impl ActionName {
     /// String value of the enum field names used in the ProtoBuf definition.
@@ -500,6  503,7 @@ impl ActionName {
             ActionName::BreakPaneLeft => "BreakPaneLeft",
             ActionName::RenameSession => "RenameSession",
             ActionName::LaunchPlugin => "LaunchPlugin",
             ActionName::Message => "Message",
         }
     }
     /// Creates an enum from field names used in the ProtoBuf definition.
@@ -587,6  591,7 @@ impl ActionName {
             "BreakPaneLeft" => Some(Self::BreakPaneLeft),
             "RenameSession" => Some(Self::RenameSession),
             "LaunchPlugin" => Some(Self::LaunchPlugin),
             "Message" => Some(Self::Message),
             _ => None,
         }
     }

diff --git a/zellij-utils/assets/prost/api.plugin_command.rs b/zellij-utils/assets/prost/api.plugin_command.rs
@@ -5,7  5,7 @@ pub struct PluginCommand {
     pub name: i32,
     #[prost(
         oneof = "plugin_command::Payload",
-        tags = "2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46"
         tags = "2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47"
     )]
     pub payload: ::core::option::Option<plugin_command::Payload>,
 }
@@ -104,6  104,8 @@ pub mod plugin_command {
         DeleteDeadSessionPayload(::prost::alloc::string::String),
         #[prost(string, tag = "46")]
         RenameSessionPayload(::prost::alloc::string::String),
         #[prost(string, tag = "47")]
         SubscribeToCustomMessagePayload(::prost::alloc::string::String),
     }
 }
 #[allow(clippy::derive_partial_eq_without_eq)]
@@ -318,6  320,7 @@ pub enum CommandName {
     DeleteDeadSession = 73,
     DeleteAllDeadSessions = 74,
     RenameSession = 75,
     SubscribeToCustomMessage = 76,
 }
 impl CommandName {
     /// String value of the enum field names used in the ProtoBuf definition.
@@ -402,6  405,7 @@ impl CommandName {
             CommandName::DeleteDeadSession => "DeleteDeadSession",
             CommandName::DeleteAllDeadSessions => "DeleteAllDeadSessions",
             CommandName::RenameSession => "RenameSession",
             CommandName::SubscribeToCustomMessage => "SubscribeToCustomMessage",
         }
     }
     /// Creates an enum from field names used in the ProtoBuf definition.
@@ -483,6  487,7 @@ impl CommandName {
             "DeleteDeadSession" => Some(Self::DeleteDeadSession),
             "DeleteAllDeadSessions" => Some(Self::DeleteAllDeadSessions),
             "RenameSession" => Some(Self::RenameSession),
             "SubscribeToCustomMessage" => Some(Self::SubscribeToCustomMessage),
             _ => None,
         }
     }

diff --git a/zellij-utils/src/cli.rs b/zellij-utils/src/cli.rs
@@ -549,4  549,8 @@ pub enum CliAction {
     RenameSession {
         name: String,
     },
     Message {
         name: String,
         payload: String,
     },
 }
diff --git a/zellij-utils/src/data.rs b/zellij-utils/src/data.rs
@@ -511,6  511,10 @@ pub enum Event {
        // headers,
        // body,
        // context
     // TODO CONTINUE HERE:
     // * add a subscribe_to_external_message() plugin command
     // * allow sending messages through zellij message (zm) <message>, <payload> and send to the
     // relevant plugins through the CustomMessage event (change its docs to reflect this)
 }
 
 #[derive(
@@ -1105,4  1109,5 @@ pub enum PluginCommand {
         BTreeMap<String, String>, // context
     ),
     RenameSession(String), // String -> new session name
     SubscribeToCustomMessage(String), // String -> message name
 }
diff --git a/zellij-utils/src/errors.rs b/zellij-utils/src/errors.rs
@@ -393,6  393,8 @@ pub enum PluginContext {
     PermissionRequestResult,
     DumpLayout,
     LogLayoutToHd,
     SubscribePluginToCustomMessage,
     Message,
 }
 
 /// Stack call representations corresponding to the different types of [`ClientInstruction`]s.

diff --git a/zellij-utils/src/input/actions.rs b/zellij-utils/src/input/actions.rs
@@ -256,6  256,7 @@ pub enum Action {
     BreakPaneRight,
     BreakPaneLeft,
     RenameSession(String),
     Message(String, String), // name, payload
 }
 
 impl Action {
@@ -582,6  583,7 @@ impl Action {
                 )])
             },
             CliAction::RenameSession { name } => Ok(vec![Action::RenameSession(name)]),
             CliAction::Message { name, payload } => Ok(vec![Action::Message(name, payload)]),
         }
     }
 }

diff --git a/zellij-utils/src/plugin_api/action.proto b/zellij-utils/src/plugin_api/action.proto
@@ -53,6  53,7 @@ message Action {
     IdAndName rename_tab_payload = 44;
     string rename_session_payload = 45;
     LaunchOrFocusPluginPayload launch_plugin_payload = 46;
     NameAndValue message_payload = 47;
   }
 }
 
@@ -227,6  228,7 @@ enum ActionName {
     BreakPaneLeft = 79;
     RenameSession = 80;
     LaunchPlugin = 81;
     Message = 82;
 }
 
 message Position {

diff --git a/zellij-utils/src/plugin_api/action.rs b/zellij-utils/src/plugin_api/action.rs
@@ -1246,6  1246,7 @@ impl TryFrom<Action> for ProtobufAction {
             | Action::Deny
             | Action::Copy
             | Action::DumpLayout
             | Action::Message(..) // TODO: let's allow this one
             | Action::SkipConfirm(..) => Err("Unsupported action"),
         }
     }

diff --git a/zellij-utils/src/plugin_api/plugin_command.proto b/zellij-utils/src/plugin_api/plugin_command.proto
@@ -87,6  87,7 @@ enum CommandName {
   DeleteDeadSession = 73;
   DeleteAllDeadSessions = 74;
   RenameSession = 75;
   SubscribeToCustomMessage = 76;
 }
 
 message PluginCommand {
@@ -137,6  138,7 @@ message PluginCommand {
     WebRequestPayload web_request_payload = 44;
     string delete_dead_session_payload = 45;
     string rename_session_payload = 46;
     string subscribe_to_custom_message_payload = 47;
   }
 }
 

diff --git a/zellij-utils/src/plugin_api/plugin_command.rs b/zellij-utils/src/plugin_api/plugin_command.rs
@@ -641,6  641,12 @@ impl TryFrom<ProtobufPluginCommand> for PluginCommand {
                 },
                 _ => Err("Mismatched payload for RenameSession"),
             },
             Some(CommandName::SubscribeToCustomMessage) => match protobuf_plugin_command.payload {
                 Some(Payload::SubscribeToCustomMessagePayload(custom_message_name)) => {
                     Ok(PluginCommand::SubscribeToCustomMessage(custom_message_name))
                 },
                 _ => Err("Mismatched payload for SubscribeToCustomMessage"),
             },
             None => Err("Unrecognized plugin command"),
         }
     }
@@ -1069,6  1075,10 @@ impl TryFrom<PluginCommand> for ProtobufPluginCommand {
                 name: CommandName::RenameSession as i32,
                 payload: Some(Payload::RenameSessionPayload(new_session_name)),
             }),
             PluginCommand::SubscribeToCustomMessage(custom_message_name) => Ok(ProtobufPluginCommand {
                 name: CommandName::SubscribeToCustomMessage as i32,
                 payload: Some(Payload::SubscribeToCustomMessagePayload(custom_message_name)),
             }),
         }
     }
 }