feat: add kde wayland support

Author: Merrit

.devcontainer/Dockerfile

@@ -11,7 +11,7 @@ RUN apt-get -y install tree
 # Install Flutter dependencies
 RUN apt-get -y install curl file git unzip xz-utils zip clang cmake ninja-build pkg-config libgtk-3-dev liblzma-dev
 # Install app-specific dependencies
-RUN apt-get -y install keybinder-3.0 appindicator3-0.1 libappindicator3-1 libappindicator3-dev
+RUN apt-get -y install keybinder-3.0 libayatana-appindicator3-dev
 
 # Install Flutter
 RUN git clone https://github.com/flutter/flutter.git -b stable /home/vscode/flutter

.github/workflows/tests.yml

@@ -13,6 +13,12 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest]
+
+    env:
+      # Needed so we don't get errors in CI
+      XDG_SESSION_TYPE: "x11"
+      XDG_CURRENT_DESKTOP: "KDE"
+
     steps:
       - uses: actions/checkout@v3
       - uses: subosito/flutter-action@v2

assets/lib/linux/active_window_kde.js

@@ -0,0 +1,41 @@
+function print(str) {
+    console.info('Nyrna KDE Wayland: ' + str);
+}
+
+print('Updating active window on DBus');
+
+function windowToJson(window) {
+    return JSON.stringify({
+        caption: window.caption,
+        pid: window.pid,
+        internalId: window.internalId,
+    });
+}
+
+function updateActiveWindowOnDBus() {
+    let activeWindow = workspace.activeWindow();
+
+    if (!activeWindow) {
+        print('No active window found');
+        return;
+    }
+    
+    let windowJson = windowToJson(activeWindow);
+
+    callDBus(
+        'codes.merritt.Nyrna',
+        '/',
+        'codes.merritt.Nyrna',
+        'updateActiveWindow',
+        windowJson,
+        (result) => {
+            if (result) {
+                print('Successfully updated active window on DBus');
+            } else {
+                print('Failed to update active window on DBus');
+            }
+        }
+    );
+}
+
+updateActiveWindowOnDBus();

assets/lib/linux/list_windows_kde.js

@@ -0,0 +1,94 @@
+// https://unix.stackexchange.com/a/706478/379240
+
+function print(str) {
+    console.info('Nyrna: ' + str);
+}
+
+let windows = workspace.windowList();
+print('Found ' + windows.length + ' windows');
+
+function updateWindowsOnDBus(windows) {
+    let windowsList = [];
+
+    for (let window of windows) {
+        windowsList.push({
+            caption: window.caption,
+            pid: window.pid,
+            internalId: window.internalId,
+            onCurrentDesktop: isWindowOnCurrentDesktop(window),
+        });
+    }
+
+    callDBus(
+        'codes.merritt.Nyrna',
+        '/',
+        'codes.merritt.Nyrna',
+        'updateWindows',
+        JSON.stringify(windowsList),
+        (result) => {
+            if (result) {
+                print('Successfully updated windows on DBus');
+            } else {
+                print('Failed to update windows on DBus');
+            }
+        }
+    );
+}
+
+function isWindowOnCurrentDesktop(window) {
+    let windowDesktops = Object.values(window.desktops);
+    let windowIsOnCurrentDesktop = window.onAllDesktops;
+
+    if (!windowIsOnCurrentDesktop) {
+        for (let windowDesktop of windowDesktops) {
+            if (windowDesktop.id === workspace.currentDesktop.id) {
+                windowIsOnCurrentDesktop = true;
+                break;
+            } else {
+                windowIsOnCurrentDesktop = false;
+            }
+        }
+    }
+
+    return windowIsOnCurrentDesktop;
+}
+
+function updateCurrentDesktopOnDBus() {
+    print('Current desktop id: ' + workspace.currentDesktop.id);
+
+    callDBus(
+        'codes.merritt.Nyrna',
+        '/',
+        'codes.merritt.Nyrna',
+        'updateCurrentDesktop',
+        workspace.currentDesktop,
+        (result) => {
+            if (result) {
+                print('Successfully updated current desktop on DBus');
+            } else {
+                print('Failed to update current desktop on DBus');
+            }
+        }
+    );
+}
+
+updateCurrentDesktopOnDBus();
+updateWindowsOnDBus(windows);
+
+workspace.currentDesktopChanged.connect(() => {
+    print('Current desktop changed');
+    updateCurrentDesktopOnDBus();
+    updateWindowsOnDBus(windows);
+});
+
+workspace.windowAdded.connect(window => {
+    print('Window added: ' + window.caption);
+    windows.push(window);
+    updateWindowsOnDBus(windows);
+});
+
+workspace.windowRemoved.connect(window => {
+    print('Window removed: ' + window.caption);
+    windows = windows.filter(w => w.internalId !== window.internalId);
+    updateWindowsOnDBus(windows);
+});

devtools_options.yaml

@@ -0,0 +1,3 @@
+description: This file stores settings for Dart & Flutter DevTools.
+documentation: https://docs.flutter.dev/tools/devtools/extensions#configure-extension-enablement-states
+extensions:

lib/active_window/src/active_window.dart

@@ -86,13 +86,31 @@ class ActiveWindow {
     log.i('Suspending');
 
     for (int attempt = 0; attempt < _maxRetries; attempt++) {
-      final window = await _nativePlatform.activeWindow();
+      final window = _nativePlatform.activeWindow;
+      if (window == null) {
+        log.w('No active window found, retrying.');
+        await _nativePlatform.checkActiveWindow();
+        await Future.delayed(const Duration(milliseconds: 500));
+      }
+
+      if (window == null && attempt < _maxRetries - 1) {
+        continue;
+      } else if (window == null && attempt == _maxRetries - 1) {
+        log.e('Failed to find active window after $_maxRetries attempts.');
+        return false;
+      } else if (window == null) {
+        log.e('Failed to find active window.');
+        return false;
+      }
+
       final String executable = window.process.executable;
 
       if (executable == 'nyrna' || executable == 'nyrna.exe') {
         log.w('Active window is Nyrna, hiding and retrying.');
         await _appWindow.hide();
         await Future.delayed(const Duration(milliseconds: 500));
+        await _nativePlatform.checkActiveWindow();
+        await Future.delayed(const Duration(milliseconds: 500));
         continue;
       }
 
@@ -141,7 +159,7 @@ class ActiveWindow {
     return false;
   }
 
-  Future<void> _minimize(int windowId) async {
+  Future<void> _minimize(String windowId) async {
     final shouldMinimize = await _getShouldMinimize();
     if (!shouldMinimize) return;
 
@@ -150,7 +168,7 @@ class ActiveWindow {
     if (!minimized) log.e('Failed to minimize window.');
   }
 
-  Future<void> _restore(int windowId) async {
+  Future<void> _restore(String windowId) async {
     final shouldRestore = await _getShouldMinimize();
     if (!shouldRestore) return;
 

lib/app/cubit/app_cubit.dart

@@ -58,7 +58,7 @@ class AppCubit extends Cubit<AppState> {
   /// blocking the UI, since none of the data fetched here is critical.
   Future<void> _init() async {
     await _checkForFirstRun();
-    await _checkLinuxSessionType();
+    _checkLinuxSessionType();
     await _fetchVersionData();
     await _fetchReleaseNotes();
     _listenToSystemTrayEvents();
@@ -74,19 +74,19 @@ class AppCubit extends Cubit<AppState> {
   }
 
   /// For Linux, checks if the session type is Wayland.
-  Future<void> _checkLinuxSessionType() async {
+  void _checkLinuxSessionType() {
     if (defaultTargetPlatform != TargetPlatform.linux) return;
 
-    final sessionType = await (_nativePlatform as Linux).sessionType();
+    final sessionType = (_nativePlatform as Linux).sessionType;
 
     final unknownSessionMsg = '''
 Unable to determine session type. The XDG_SESSION_TYPE environment variable is set to "$sessionType".
 Please note that Wayland is not currently supported.''';
 
     const waylandNotSupportedMsg = '''
-Wayland is not currently supported.
+Wayland is currently supported only on KDE Plasma.
 
-Only xwayland apps will be detected.
+For other desktop environments, only xwayland apps will be detected.
 
 If Wayland support is important to you, consider voting on the issue:
 
@@ -106,12 +106,19 @@ env QT_QPA_PLATFORM=xcb <app>
 
 Otherwise, [consider signing in using X11 instead](https://docs.fedoraproject.org/en-US/quick-docs/configuring-xorg-as-default-gnome-session/).''';
 
-    switch (sessionType) {
-      case 'wayland':
-        log.w(waylandNotSupportedMsg);
-        emit(state.copyWith(linuxSessionMessage: waylandNotSupportedMsg));
-        return;
-      case 'x11':
+    emit(state.copyWith(sessionType: sessionType));
+
+    log.i('Session type: $sessionType');
+
+    switch (sessionType.displayProtocol) {
+      case DisplayProtocol.wayland:
+        if (sessionType.environment == DesktopEnvironment.kde) {
+          log.i('KDE Wayland session detected and is supported, proceeding.');
+        } else {
+          log.w(waylandNotSupportedMsg);
+          emit(state.copyWith(linuxSessionMessage: waylandNotSupportedMsg));
+        }
+      case DisplayProtocol.x11:
         break;
       default:
         log.w(unknownSessionMsg);
@@ -202,4 +209,10 @@ Otherwise, [consider signing in using X11 instead](https://docs.fedoraproject.or
       return false;
     }
   }
+
+  @override
+  Future<void> close() async {
+    await _nativePlatform.dispose();
+    await super.close();
+  }
 }

lib/app/cubit/app_state.dart

@@ -7,6 +7,11 @@ class AppState with _$AppState {
     /// session type is unknown.
     String? linuxSessionMessage,
 
+    /// The type of desktop session the user is running.
+    ///
+    /// Currently only used on Linux.
+    SessionType? sessionType,
+
     /// True if this is the first run of the app.
     required bool firstRun,
     required String runningVersion,

lib/apps_list/cubit/apps_list_cubit.dart

@@ -226,6 +226,7 @@ class AppsListCubit extends Cubit<AppsListState> {
       _storage,
     );
 
+    await _nativePlatform.checkActiveWindow();
     return await activeWindow.toggle();
   }
 

lib/apps_list/models/interaction_error.dart

@@ -5,7 +5,7 @@ import '../enums.dart';
 class InteractionError {
   final InteractionType interactionType;
   final ProcessStatus statusAfterInteraction;
-  final int windowId;
+  final String windowId;
 
   const InteractionError({
     required this.interactionType,