Merge pull request #946 from JakeStanger/fix/wayland-panic

fix(wayland): panicking on compositors without protocol support

.github/workflows/build.yml

@@ -5,13 +5,13 @@ on:
   push:
     branches: [ "master" ]
     paths:
-      - 'src'
+      - 'src/**/*'
       - 'Cargo.*'
       - 'build.rs'
   pull_request:
     branches: [ "master" ]
     paths:
-      - 'src'
+      - 'src/**/*'
       - 'Cargo.*'
       - 'build.rs'
       - '.github/workflows/build.yml'

.github/workflows/schema.yml

@@ -5,7 +5,7 @@ on:
   push:
     branches: [ "master" ]
     paths:
-      - 'src'
+      - 'src/**/*'
       - 'Cargo.*'
       - 'build.rs'
       - '.github/workflows/schema.yml'

.github/workflows/wiki.yml

@@ -4,7 +4,7 @@ on:
   push:
     branches: [ "master" ]
     paths:
-      - 'docs'
+      - 'docs/**/*'
 
 jobs:
   build:

src/clients/wayland/mod.rs

@@ -9,7 +9,7 @@ use std::sync::{Arc, Mutex};
 
 use calloop_channel::Event::Msg;
 use cfg_if::cfg_if;
-use color_eyre::Report;
+use color_eyre::{Help, Report};
 use smithay_client_toolkit::output::OutputState;
 use smithay_client_toolkit::reexports::calloop::EventLoop;
 use smithay_client_toolkit::reexports::calloop::channel as calloop_channel;
@@ -204,7 +204,7 @@ pub struct Environment {
 
     // -- clipboard --
     #[cfg(feature = "clipboard")]
-    data_control_device_manager_state: DataControlDeviceManagerState,
+    data_control_device_manager_state: Option<DataControlDeviceManagerState>,
 
     #[cfg(feature = "clipboard")]
     data_control_devices: Vec<DataControlDeviceEntry>,
@@ -263,12 +263,30 @@ impl Environment {
         let output_state = OutputState::new(&globals, &qh);
         let seat_state = SeatState::new(&globals, &qh);
         #[cfg(any(feature = "focused", feature = "launcher"))]
-        ToplevelManagerState::bind(&globals, &qh)
+        if let Err(err) = ToplevelManagerState::bind(&globals, &qh) {
-            .expect("to bind to wlr_foreign_toplevel_manager global");
+            error!("{:?}",
+                Report::new(err)
+                    .wrap_err("Failed to bind to wlr_foreign_toplevel_manager global")
+                    .note("This is likely a due to the current compositor not supporting the required protocol")
+                    .note("launcher and focused modules will not work")
+            );
+        }
 
         #[cfg(feature = "clipboard")]
-        let data_control_device_manager_state = DataControlDeviceManagerState::bind(&globals, &qh)
+        let data_control_device_manager_state = match DataControlDeviceManagerState::bind(
-            .expect("to bind to wlr_data_control_device_manager global");
+            &globals, &qh,
+        ) {
+            Ok(state) => Some(state),
+            Err(err) => {
+                error!("{:?}",
+                    Report::new(err)
+                        .wrap_err("Failed to bind to wlr_data_control_device global")
+                        .note("This is likely a due to the current compositor not supporting the required protocol")
+                        .note("clipboard module will not work")
+                    );
+                None
+            }
+        };
 
         let mut env = Self {
             registry_state,

src/clients/wayland/wl_seat.rs

@@ -1,6 +1,6 @@
 use super::Environment;
 use smithay_client_toolkit::seat::{Capability, SeatHandler, SeatState};
-use tracing::debug;
+use tracing::{debug, error};
 use wayland_client::protocol::wl_seat::WlSeat;
 use wayland_client::{Connection, QueueHandle};
 
@@ -37,7 +37,11 @@ impl SeatHandler for Environment {
         {
             debug!("Adding new data control device");
             // create the data device here for this seat
-            let data_control_device_manager = &self.data_control_device_manager_state;
+            let Some(data_control_device_manager) = &self.data_control_device_manager_state else {
+                error!("data_control_device_manager not available, cannot copy");
+                return;
+            };
+
             let data_control_device = data_control_device_manager.get_data_device(qh, &seat);
             self.data_control_devices
                 .push(super::DataControlDeviceEntry {

src/clients/wayland/wlr_data_control/mod.rs

@@ -147,6 +147,11 @@ impl Environment {
     pub fn copy_to_clipboard(&mut self, item: ClipboardItem) {
         debug!("Copying item to clipboard: {item:?}");
 
+        let Some(data_control_device_manager) = &self.data_control_device_manager_state else {
+            error!("data_control_device_manager not available, cannot copy");
+            return;
+        };
+
         let seat = self.default_seat();
         let Some(device) = self
             .data_control_devices
@@ -156,8 +161,7 @@ impl Environment {
             return;
         };
 
-        let source = self
+        let source = data_control_device_manager
-            .data_control_device_manager_state
             .create_copy_paste_source(&self.queue_handle, [&item.mime_type, INTERNAL_MIME_TYPE]);
 
         source.set_selection(&device.device);