Merge pull request #120 from wakatime/major/idle-time

Switch from global keylogger to idle time interval

Author: alanhamlett

electron/watchers/watcher.ts

@@ -1,11 +1,10 @@
-import type { IGlobalKeyListener } from "node-global-key-listener";
 import {
   activeWindow,
   subscribeActiveWindow,
   unsubscribeActiveWindow,
   WindowInfo,
 } from "@miniben90/x-win";
-import { GlobalKeyboardListener } from "node-global-key-listener";
+import { powerMonitor } from "electron";
 
 import { AppsManager } from "../helpers/apps-manager";
 import { MonitoredApp } from "../helpers/monitored-app";
@@ -17,23 +16,21 @@ export class Watcher {
   wakatime: Wakatime;
   activeWindow?: WindowInfo;
   private activeWindowSubscription: number | null;
-  private gkl: GlobalKeyboardListener;
-  private isWatchingForKeyboardEvents = false;
+  private interval: NodeJS.Timeout | null;
 
   constructor(wakatime: Wakatime) {
     this.wakatime = wakatime;
     this.activeWindowSubscription = null;
-    this.gkl = new GlobalKeyboardListener();
+    this.interval = null;
   }
 
-  private globalKeyListener: IGlobalKeyListener = (event) => {
-    if (event.state !== "DOWN") {
-      return;
-    }
-
+  private handleActivity() {
     try {
-      // To ensure we always retrieve the most current window information, including the updated URL and title, we use the activeWindow function instead of relying on the previously stored this.activeApp. This approach addresses the issue where switching tabs in your browser does not trigger a window change event, leading to activeApp retaining outdated URL and title information.
       const window = activeWindow();
+      if (!MonitoringManager.isMonitored(window.info.path)) {
+        return;
+      }
+
       const app = AppsManager.instance().getApp(window.info.path);
       const heartbeatData = MonitoredApp.heartbeatData(window, app);
       if (!heartbeatData) {
@@ -53,58 +50,39 @@ export class Watcher {
     } catch (error) {
       Logging.instance().log((error as Error).message, LogLevel.ERROR, true);
     }
-  };
-
-  private watchKeyboardEvents() {
-    this.isWatchingForKeyboardEvents = true;
-    this.gkl.addListener(this.globalKeyListener);
-  }
-
-  private unwatchKeyboardEvents() {
-    this.isWatchingForKeyboardEvents = false;
-    this.gkl.removeListener(this.globalKeyListener);
   }
 
   start() {
+    this.stop();
     this.activeWindowSubscription = subscribeActiveWindow(
       (windowInfo: WindowInfo) => {
         if (!windowInfo.info.processId) return;
         if (this.activeWindow?.info.processId === windowInfo.info.processId) {
           return;
         }
 
-        if (this.isWatchingForKeyboardEvents) {
-          this.unwatchKeyboardEvents();
-        }
-
         Logging.instance().log(
           `App changed from ${this.activeWindow?.info.name || "nil"} to ${windowInfo.info.name}`,
         );
-
         this.activeWindow = windowInfo;
-        if (this.activeWindow.info.path) {
-          const isMonitored = MonitoringManager.isMonitored(
-            this.activeWindow.info.path,
-          );
 
-          if (isMonitored) {
-            Logging.instance().log(
-              `Monitoring ${windowInfo.info.name}: ${this.activeWindow.info.path}`,
-            );
-            this.watchKeyboardEvents();
-          } else {
-            Logging.instance().log(
-              `Not monitoring ${windowInfo.info.name}: ${this.activeWindow.info.path}`,
-            );
-          }
-        }
+        this.handleActivity();
       },
     );
+    this.interval = setInterval(() => {
+      const idleState = powerMonitor.getSystemIdleState(10);
+      if (idleState === "active") {
+        this.handleActivity();
+      }
+    }, 5000);
   }
 
   stop() {
     if (this.activeWindowSubscription !== null) {
       unsubscribeActiveWindow(this.activeWindowSubscription);
     }
+    if (this.interval !== null) {
+      clearInterval(this.interval);
+    }
   }
 }

package-lock.json

@@ -38,7 +38,6 @@
     "iconutil": "^1.0.2",
     "lucide-react": "^0.428.0",
     "node-fetch": "^3.3.2",
-    "node-global-key-listener": "^0.3.0",
     "plist": "^3.1.0",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
@@ -80,4 +79,4 @@
     "vite-plugin-native": "^2.2.1"
   },
   "main": "dist-electron/main.js"
-}
+}

package.json

@@ -14,11 +14,7 @@ export default defineConfig({
         vite: {
           build: {
             rollupOptions: {
-              external: [
-                "@miniben90/x-win",
-                "node-global-key-listener",
-                "icon-promise",
-              ],
+              external: ["@miniben90/x-win", "icon-promise"],
             },
             minify: false,
           },