feat: RDP monitoring toggle & config improvements

This commit addresses the performance issues caused by RDP monitoring on some systems by adding a toggle to disable it, and setting the default to false.

The config class has also been improved by giving it the ability to fill and write missing keys (useful when updating the config with new keys)

Author: TibixDev

package.json

@@ -1,6 +1,6 @@
 {
     "name": "winboat",
-    "version": "0.6.6",
+    "version": "0.6.7",
     "description": "Windows for Penguins",
     "main": "main/main.js",
     "scripts": {

src/renderer/lib/config.ts

@@ -5,11 +5,13 @@ import { WINBOAT_DIR } from "./constants";
 export type WinboatConfigObj = {
     scale: number;
     smartcardEnabled: boolean
+    rdpMonitoringEnabled: boolean
 };
 
 const defaultConfig: WinboatConfigObj = {
     scale: 100,
-    smartcardEnabled: false
+    smartcardEnabled: false,
+    rdpMonitoringEnabled: false,
 };
 
 let instance: WinboatConfig | null = null;
@@ -57,8 +59,28 @@ export class WinboatConfig {
 
         try {
             const rawConfig = fs.readFileSync(this.#configPath, "utf-8");
+            const configObj = JSON.parse(rawConfig) as WinboatConfigObj;
             console.log("Successfully read the config file");
-            return { ...JSON.parse(rawConfig) as WinboatConfigObj };
+
+            // Some fields might be missing after an update, so we merge them with the default config
+            for (const key in defaultConfig) {
+                let hasMissing = false;
+                if (!(key in configObj)) {
+                    // @ts-expect-error This is valid
+                    configObj[key] = defaultConfig[key];
+                    hasMissing = true;
+                    console.log(`Added missing config key: ${key} with default value: ${defaultConfig[key as keyof WinboatConfigObj]}`);
+                }
+
+                // If we have any missing keys, we should just write the config back to disk so those new keys are saved
+                // We cannot use this.writeConfig() here since #configData is not populated yet
+                if (hasMissing) {
+                    fs.writeFileSync(this.#configPath, JSON.stringify(configObj, null, 4), "utf-8");
+                    console.log("Wrote updated config with missing keys to disk");
+                }
+            }
+
+            return { ...configObj };
         } catch (e) {
             console.error("Config’s borked, outputting the default:", e);
             return { ...defaultConfig };

src/renderer/lib/winboat.ts

@@ -215,8 +215,18 @@ export class Winboat {
             clearInterval(this.#rdpConnectionStatusInterval);
             this.#rdpConnectionStatusInterval = null;
         }
+
         this.#rdpConnectionStatusInterval = setInterval(async () => {
+            // If the guest is offline, don't even bother checking RDP status
             if (!this.isOnline.value) return;
+
+            // If RDP monitoring is disabled, don't check status, just set it to false
+            if (!this.#wbConfig?.config.rdpMonitoringEnabled) {
+                this.rdpConnected.value = false;
+                return;
+            }
+
+            // Check RDP status
             const _rdpConnected = await this.getRDPConnectedStatus();
             if (_rdpConnected !== this.rdpConnected.value) {
                 this.rdpConnected.value = _rdpConnected;

src/renderer/views/Config.vue

@@ -123,6 +123,27 @@
                         ></x-switch>
                     </div>
                 </x-card>
+                <x-card
+                    class="flex items-center p-2 flex-row justify-between w-full py-3 my-0 bg-neutral-800/20 backdrop-brightness-150 backdrop-blur-xl">
+                    <div>
+                        <div class="flex flex-row items-center gap-2 mb-2">
+                            <Icon class="text-violet-400 inline-flex size-8" icon="fluent:remote-16-filled"></Icon>
+                            <h1 class="text-lg my-0 font-semibold">
+                                RDP Monitoring
+                            </h1>
+                        </div>
+                        <p class="text-neutral-400 text-[0.9rem] !pt-0 !mt-0">
+                            If enabled, a banner will appear when the RDP session is connected (may cause high CPU usage, disable if you notice performance issues)
+                        </p>
+                    </div>
+                    <div class="flex flex-row justify-center items-center gap-2">
+                        <x-switch
+                            :toggled="wbConfig.config.rdpMonitoringEnabled"
+                            @toggle="(_: any) => wbConfig.config.rdpMonitoringEnabled = !wbConfig.config.rdpMonitoringEnabled"
+                            size="large"
+                        ></x-switch>
+                    </div>
+                </x-card>
             </div>
         </div>
         <div>