diff options
| author | Aram Drevekenin <aram@poor.dev> | 2025-06-23 19:19:37 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-06-23 19:19:37 +0200 |
| commit | c5ac7968809ddb1033b625562eae22019cccc2f4 (patch) | |
| tree | 932cf07d898dfbcc6ec6a9d4cf5353c06a47accc /zellij-utils/src/plugin_api/event.rs | |
| parent | feat(ui): add optional tooltip with key hints to the compact bar (#4225) (diff) | |
| download | sl0ppij-c5ac7968809ddb1033b625562eae22019cccc2f4.tar.gz sl0ppij-c5ac7968809ddb1033b625562eae22019cccc2f4.tar.xz sl0ppij-c5ac7968809ddb1033b625562eae22019cccc2f4.zip | |
Feature: web-client/server to share your sessions in the browser (#4242)
* work
* moar work
* notes
* work
* separate to terminal and control channels
* stdin working
* serve html web client initial
* serve static assets loaded with include_dir
* merge
* enable_web_server config parameter
* compile time flag to disable web server capability
* rustfmt
* add license to all xterm.js assets
* mouse working except copy/paste
* helpful comment
* web client improvements
- move script to js file
- add favicon
- add nerd font
- change title
TODO: investigate if font license embedded in otf is sufficient
* get mouse to work properly
* kitty keyboard support initial
* fix wrong type in preload link
* wip axum websocket handlers
- upgrade axum to v0.8.1, enable ws feature
- begin setup of websocket handlers
- tidy up imports
* replace control listener
* handle terminal websocket with axum
* cleanup Cargo.toml
* kitty fixes and bracketed paste
* fix(mouse): pane not found crash
* initial session switching infra
* add `web_client_font` option
* session switching, creation and resurrection working through the session manager
* move session module to zellij-utils and share logic with web-client
* some cleanups
* require restart for enable-web-server
* use session name from router
* write config to disk and watch for config changes
* rename session name to ipc path
* add basic panic handler, make render_to_client exit on channel close
* use while let instead of loop
* handle websocket close
* add mouse motions
* make clipboard work
* add weblink handling and webgl rendering
* add todo
* fix: use session name instead of patch on session switch
* use "default" layout for new sessions
* ui indication for session being shared
* share this session ui
* plugin assets
* Fix process crash on mac with notify watcher.
Use poll watcher instead of recommended as a workaround.
* make url session switching and creation work
* start welcome screen on root url
* scaffold control messages, set font from config
* set dimensions on session start
* bring back session name from url
* send bytes on terminal websocket instead of json
- create web client os input and id before websocket connection
* draft ui
* work
* refactor ui
* remove otf font, remove margins to avoid scrollbar
* version query endpoint for server status
* web session info query endpoint
* refactor: move stuff around
* add web client info to session metadata
* make tests pass
* populate real data in session list
* remove unnecessary endpoint
* add web_client node to config, add font option
* remove web_client_font
* allow disabling the web session through the config - WIP
* formalize sharing/not-sharing configuration
* fix tests
* allow shutting down web server
* display error when web clients are forbidden to attach
* only show sessions that allow web clients if this is a web client
* style(fmt): rustfmt
* fix: query web server from Zellij rather than from each plugin
* remove log spam
* handle some error paths better in the web client
* allow controlling the web server through the cli
* allow configuring the web server's ip/port
* fix tests and format code
* use direct WebServerStatus event instead of piggy-backing on SessionInfo
* plugin revamp initial
* make plugin responsive
* adjust plugin title
* refactor: share plugin
* refactor: share plugin
* add cors middleware
* some fixes for running without a compiled web server capability
* display error when starting the share plugin without web server support
* clarify config
* add pipelines to compile zellij without web support
* display error when unable to start web server
* only query web server when share plugin is running
* refactor(web-client): connection table
* give zellij_server_listener access to the control channel
* fixes and clarifications
* refactor: consolidate generate_unique_session_name
* give proper error when trying to attach to a forbidden session
* change browser URL when switching sessions
* add keyboard shortcut
* enforce https when bound to non-loopback ip
* initial authentication token implementation
* background color from theme
* initial web client theme config
* basic token generation ui
* refactor set config message creation
* also set body background
* allow editing scrollback for plugins too
* set scrollback to 0
* properly parse colors in config
* generate token from plugin
* nice login modals
* initial token management screen
* implement token authentication
* refactor(share): token management screen
* style(fmt): rustfmt
* fix(plugin): some minor bugs
* refactor(share): main screen
* refactor(share): token screen
* refactor(share): main
* refactor(share): ui components
* fix(responsiveness): properly send usage_width to the render function
* fix cli commands and add some verbosity
* add support for settings ansi and selection colors
* add cursor and cursor accent
* basic web client tests
* fix tests
* refactor: web client
* use session tokens for authentication
* improve modals
* move shutdown to ipc
* refactor: ipc logic
* serialize theme config for web client
* update tests
* refactor: move some stuff around to prepare for config hot reload
* config live reloading for the web clients
* change remember-me UI wording
* improve xterm.js link handling
* make sure terminal is focused on mousemove
* remove deprecated sharing indication from compact-bar
* gate deps and functionality behind the web_server_compatibility feature
* feat(build): add --no-web flag in all the places
* fix some other build flows
* add new assets
* update CI for no-web (untested)
* make more dependencies optional
* update axum-extra
* add web client configuration options
* gracefully close connections on server exit
* tests for graceful connection closing
* handle client-side reconnect when server is down
* fix: make sure ipc bus folder exists before starting
* add commands to manage login tokens from the cli
* style(fmt): rustfmt
* some cleanups
* fix(ux): allow alt-right-click on the web client without opening the context menu
* fix: prevent attaching to welcome screen
* fix: reload config issues
* fix long socket path on macos
* normalize config conversion and fix color gap in browser
* revoke session_token cookie if it is not valid
* fix: visual bug with multiple clients in extremely small screen sizes
* fix: only include rusqlite for the web server capability builds
* update e2e snapshots
* refactor(web): client side js
* some cleanups
* moar cleanups
* fix(tests): wait for server instead of using a fixed timeout
* debug CI
* fix(tests): use spawn_blocking for running the test web server
* fix(tests): wait for http rather than tcp port
* fix(tests): properly pass config path - hopefully this is the issue...
* success! bring back the rest of the tests
* attempt to fix the macos CI issue
* docs(changelog): add PR
---------
Co-authored-by: Thomas Linford <linford.t@gmail.com>
Diffstat (limited to 'zellij-utils/src/plugin_api/event.rs')
| -rw-r--r-- | zellij-utils/src/plugin_api/event.rs | 154 |
1 files changed, 152 insertions, 2 deletions
diff --git a/zellij-utils/src/plugin_api/event.rs b/zellij-utils/src/plugin_api/event.rs index a853e12d..e363b86c 100644 --- a/zellij-utils/src/plugin_api/event.rs +++ b/zellij-utils/src/plugin_api/event.rs @@ -10,7 +10,9 @@ pub use super::generated_api::api::{ PaneId as ProtobufPaneId, PaneInfo as ProtobufPaneInfo, PaneManifest as ProtobufPaneManifest, PaneType as ProtobufPaneType, PluginInfo as ProtobufPluginInfo, ResurrectableSession as ProtobufResurrectableSession, - SessionManifest as ProtobufSessionManifest, TabInfo as ProtobufTabInfo, *, + SessionManifest as ProtobufSessionManifest, TabInfo as ProtobufTabInfo, + WebServerStatusPayload as ProtobufWebServerStatusPayload, WebSharing as ProtobufWebSharing, + *, }, input_mode::InputMode as ProtobufInputMode, key::Key as ProtobufKey, @@ -20,7 +22,7 @@ pub use super::generated_api::api::{ use crate::data::{ ClientInfo, CopyDestination, Event, EventType, FileMetadata, InputMode, KeyWithModifier, LayoutInfo, ModeInfo, Mouse, PaneId, PaneInfo, PaneManifest, PermissionStatus, - PluginCapabilities, PluginInfo, SessionInfo, Style, TabInfo, + PluginCapabilities, PluginInfo, SessionInfo, Style, TabInfo, WebServerStatus, WebSharing, }; use crate::errors::prelude::*; @@ -28,7 +30,9 @@ use crate::input::actions::Action; use std::collections::{BTreeMap, HashMap, HashSet}; use std::convert::TryFrom; +use std::net::IpAddr; use std::path::PathBuf; +use std::str::FromStr; use std::time::Duration; impl TryFrom<ProtobufEvent> for Event { @@ -359,10 +363,24 @@ impl TryFrom<ProtobufEvent> for Event { None => Ok(Event::ConfigWasWrittenToDisk), _ => Err("Malformed payload for the ConfigWasWrittenToDisk Event"), }, + Some(ProtobufEventType::WebServerStatus) => match protobuf_event.payload { + Some(ProtobufEventPayload::WebServerStatusPayload(web_server_status)) => { + Ok(Event::WebServerStatus(web_server_status.try_into()?)) + }, + _ => Err("Malformed payload for the WebServerStatus Event"), + }, Some(ProtobufEventType::BeforeClose) => match protobuf_event.payload { None => Ok(Event::BeforeClose), _ => Err("Malformed payload for the BeforeClose Event"), }, + Some(ProtobufEventType::FailedToStartWebServer) => match protobuf_event.payload { + Some(ProtobufEventPayload::FailedToStartWebServerPayload( + failed_to_start_web_server_payload, + )) => Ok(Event::FailedToStartWebServer( + failed_to_start_web_server_payload.error, + )), + _ => Err("Malformed payload for the FailedToStartWebServer Event"), + }, Some(ProtobufEventType::InterceptedKeyPress) => match protobuf_event.payload { Some(ProtobufEventPayload::KeyPayload(protobuf_key)) => { Ok(Event::InterceptedKeyPress(protobuf_key.try_into()?)) @@ -743,10 +761,22 @@ impl TryFrom<Event> for ProtobufEvent { name: ProtobufEventType::ConfigWasWrittenToDisk as i32, payload: None, }), + Event::WebServerStatus(web_server_status) => Ok(ProtobufEvent { + name: ProtobufEventType::WebServerStatus as i32, + payload: Some(event::Payload::WebServerStatusPayload( + ProtobufWebServerStatusPayload::try_from(web_server_status)?, + )), + }), Event::BeforeClose => Ok(ProtobufEvent { name: ProtobufEventType::BeforeClose as i32, payload: None, }), + Event::FailedToStartWebServer(error) => Ok(ProtobufEvent { + name: ProtobufEventType::FailedToStartWebServer as i32, + payload: Some(event::Payload::FailedToStartWebServerPayload( + FailedToStartWebServerPayload { error }, + )), + }), Event::InterceptedKeyPress(key) => Ok(ProtobufEvent { name: ProtobufEventType::InterceptedKeyPress as i32, payload: Some(event::Payload::KeyPayload(key.try_into()?)), @@ -789,6 +819,8 @@ impl TryFrom<SessionInfo> for ProtobufSessionManifest { .into_iter() .map(|p| ProtobufPluginInfo::from(p)) .collect(), + web_clients_allowed: session_info.web_clients_allowed, + web_client_count: session_info.web_client_count as u32, tab_history: session_info .tab_history .into_iter() @@ -878,6 +910,8 @@ impl TryFrom<ProtobufSessionManifest> for SessionInfo { .filter_map(|l| LayoutInfo::try_from(l).ok()) .collect(), plugins, + web_clients_allowed: protobuf_session_manifest.web_clients_allowed, + web_client_count: protobuf_session_manifest.web_client_count as usize, tab_history, }) } @@ -1249,11 +1283,29 @@ impl TryFrom<ProtobufModeUpdatePayload> for ModeInfo { .editor .map(|e| PathBuf::from(e)); let shell = protobuf_mode_update_payload.shell.map(|s| PathBuf::from(s)); + let web_clients_allowed = protobuf_mode_update_payload.web_clients_allowed; + let web_sharing = protobuf_mode_update_payload + .web_sharing + .and_then(|w| ProtobufWebSharing::from_i32(w)) + .map(|w| w.into()); let capabilities = PluginCapabilities { arrow_fonts: protobuf_mode_update_payload.arrow_fonts_support, }; let currently_marking_pane_group = protobuf_mode_update_payload.currently_marking_pane_group; + let is_web_client = protobuf_mode_update_payload.is_web_client; + + let web_server_ip = protobuf_mode_update_payload + .web_server_ip + .as_ref() + .and_then(|web_server_ip| IpAddr::from_str(web_server_ip).ok()); + + let web_server_port = protobuf_mode_update_payload + .web_server_port + .map(|w| w as u16); + + let web_server_capability = protobuf_mode_update_payload.web_server_capability; + let mode_info = ModeInfo { mode: current_mode, keybinds, @@ -1263,7 +1315,13 @@ impl TryFrom<ProtobufModeUpdatePayload> for ModeInfo { base_mode, editor, shell, + web_clients_allowed, + web_sharing, currently_marking_pane_group, + is_web_client, + web_server_ip, + web_server_port, + web_server_capability, }; Ok(mode_info) } @@ -1281,7 +1339,13 @@ impl TryFrom<ModeInfo> for ProtobufModeUpdatePayload { let session_name = mode_info.session_name; let editor = mode_info.editor.map(|e| e.display().to_string()); let shell = mode_info.shell.map(|s| s.display().to_string()); + let web_clients_allowed = mode_info.web_clients_allowed; + let web_sharing = mode_info.web_sharing.map(|w| w as i32); let currently_marking_pane_group = mode_info.currently_marking_pane_group; + let is_web_client = mode_info.is_web_client; + let web_server_ip = mode_info.web_server_ip.map(|i| format!("{}", i)); + let web_server_port = mode_info.web_server_port.map(|p| p as u32); + let web_server_capability = mode_info.web_server_capability; let mut protobuf_input_mode_keybinds: Vec<ProtobufInputModeKeybinds> = vec![]; for (input_mode, input_mode_keybinds) in mode_info.keybinds { let mode: ProtobufInputMode = input_mode.try_into()?; @@ -1315,7 +1379,13 @@ impl TryFrom<ModeInfo> for ProtobufModeUpdatePayload { base_mode: base_mode.map(|b_m| b_m as i32), editor, shell, + web_clients_allowed, + web_sharing, currently_marking_pane_group, + is_web_client, + web_server_ip, + web_server_port, + web_server_capability, }) } } @@ -1385,7 +1455,9 @@ impl TryFrom<ProtobufEventType> for EventType { ProtobufEventType::FailedToChangeHostFolder => EventType::FailedToChangeHostFolder, ProtobufEventType::PastedText => EventType::PastedText, ProtobufEventType::ConfigWasWrittenToDisk => EventType::ConfigWasWrittenToDisk, + ProtobufEventType::WebServerStatus => EventType::WebServerStatus, ProtobufEventType::BeforeClose => EventType::BeforeClose, + ProtobufEventType::FailedToStartWebServer => EventType::FailedToStartWebServer, ProtobufEventType::InterceptedKeyPress => EventType::InterceptedKeyPress, }) } @@ -1426,7 +1498,9 @@ impl TryFrom<EventType> for ProtobufEventType { EventType::FailedToChangeHostFolder => ProtobufEventType::FailedToChangeHostFolder, EventType::PastedText => ProtobufEventType::PastedText, EventType::ConfigWasWrittenToDisk => ProtobufEventType::ConfigWasWrittenToDisk, + EventType::WebServerStatus => ProtobufEventType::WebServerStatus, EventType::BeforeClose => ProtobufEventType::BeforeClose, + EventType::FailedToStartWebServer => ProtobufEventType::FailedToStartWebServer, EventType::InterceptedKeyPress => ProtobufEventType::InterceptedKeyPress, }) } @@ -1568,7 +1642,13 @@ fn serialize_mode_update_event_with_non_default_values() { base_mode: Some(InputMode::Locked), editor: Some(PathBuf::from("my_awesome_editor")), shell: Some(PathBuf::from("my_awesome_shell")), + web_clients_allowed: Some(true), + web_sharing: Some(WebSharing::default()), currently_marking_pane_group: Some(false), + is_web_client: Some(false), + web_server_ip: IpAddr::from_str("127.0.0.1").ok(), + web_server_port: Some(8082), + web_server_capability: Some(true), }); let protobuf_event: ProtobufEvent = mode_update_event.clone().try_into().unwrap(); let serialized_protobuf_event = protobuf_event.encode_to_vec(); @@ -2016,6 +2096,8 @@ fn serialize_session_update_event_with_non_default_values() { LayoutInfo::File("layout3".to_owned()), ], plugins, + web_clients_allowed: false, + web_client_count: 1, tab_history, }; let session_info_2 = SessionInfo { @@ -2032,6 +2114,8 @@ fn serialize_session_update_event_with_non_default_values() { LayoutInfo::File("layout3".to_owned()), ], plugins: Default::default(), + web_clients_allowed: false, + web_client_count: 0, tab_history: Default::default(), }; let session_infos = vec![session_info_1, session_info_2]; @@ -2081,3 +2165,69 @@ impl TryFrom<PaneId> for ProtobufPaneId { } } } + +impl Into<ProtobufWebSharing> for WebSharing { + fn into(self) -> ProtobufWebSharing { + match self { + WebSharing::On => ProtobufWebSharing::On, + WebSharing::Off => ProtobufWebSharing::Off, + WebSharing::Disabled => ProtobufWebSharing::Disabled, + } + } +} + +impl Into<WebSharing> for ProtobufWebSharing { + fn into(self) -> WebSharing { + match self { + ProtobufWebSharing::On => WebSharing::On, + ProtobufWebSharing::Off => WebSharing::Off, + ProtobufWebSharing::Disabled => WebSharing::Disabled, + } + } +} + +impl TryFrom<WebServerStatus> for ProtobufWebServerStatusPayload { + type Error = &'static str; + fn try_from(web_server_status: WebServerStatus) -> Result<Self, &'static str> { + match web_server_status { + WebServerStatus::Online(url) => Ok(ProtobufWebServerStatusPayload { + web_server_status_indication: WebServerStatusIndication::Online as i32, + payload: Some(url), + }), + WebServerStatus::DifferentVersion(version) => Ok(ProtobufWebServerStatusPayload { + web_server_status_indication: WebServerStatusIndication::DifferentVersion as i32, + payload: Some(format!("{}", version)), + }), + WebServerStatus::Offline => Ok(ProtobufWebServerStatusPayload { + web_server_status_indication: WebServerStatusIndication::Offline as i32, + payload: None, + }), + } + } +} + +impl TryFrom<ProtobufWebServerStatusPayload> for WebServerStatus { + type Error = &'static str; + fn try_from( + protobuf_web_server_status: ProtobufWebServerStatusPayload, + ) -> Result<Self, &'static str> { + match WebServerStatusIndication::from_i32( + protobuf_web_server_status.web_server_status_indication, + ) { + Some(WebServerStatusIndication::Online) => { + let payload = protobuf_web_server_status + .payload + .ok_or("payload_not_found")?; + Ok(WebServerStatus::Online(payload)) + }, + Some(WebServerStatusIndication::DifferentVersion) => { + let payload = protobuf_web_server_status + .payload + .ok_or("payload_not_found")?; + Ok(WebServerStatus::DifferentVersion(payload)) + }, + Some(WebServerStatusIndication::Offline) => Ok(WebServerStatus::Offline), + None => Err("Unknown status"), + } + } +} |
