Electron API: Add sentry capture and get electron version. (#175)

* Electron API for version.

* Send error to sentry.

src/constants.ts

@@ -19,6 +19,8 @@ export const IPC_CHANNELS = {
   CANCEL_DOWNLOAD: 'cancel-download',
   DELETE_MODEL: 'delete-model',
   GET_ALL_DOWNLOADS: 'get-all-downloads',
+  GET_ELECTRON_VERSION: 'get-electron-version',
+  SEND_ERROR_TO_SENTRY: 'send-error-to-sentry',
 } as const;
 
 export const COMFY_ERROR_MESSAGE =

src/main.ts

@@ -1,5 +1,4 @@
 import { spawn, ChildProcess } from 'node:child_process';
-import * as fsPromises from 'node:fs/promises';
 import fs from 'fs';
 import axios from 'axios';
 import path from 'node:path';
@@ -33,7 +32,7 @@ let mainWindow: BrowserWindow | null = null;
 let store: Store<StoreType> | null = null;
 const messageQueue: Array<any> = []; // Stores mesaages before renderer is ready.
 let downloadManager: DownloadManager;
-
+Sentry.captureMessage('Hello, world!');
 log.initialize();
 
 const comfySettings = new ComfySettings(app.getPath('documents'));
@@ -91,18 +90,24 @@ if (!gotTheLock) {
     }
   });
 
-  app.isPackaged &&
-    comfySettings.sendCrashStatistics &&
-    Sentry.init({
-      dsn: SENTRY_URL_ENDPOINT,
-      autoSessionTracking: false,
-      integrations: [
-        Sentry.childProcessIntegration({
-          breadcrumbs: ['abnormal-exit', 'killed', 'crashed', 'launch-failed', 'oom', 'integrity-failure'],
-          events: ['abnormal-exit', 'killed', 'crashed', 'launch-failed', 'oom', 'integrity-failure'],
-        }),
-      ],
-    });
+  Sentry.init({
+    dsn: SENTRY_URL_ENDPOINT,
+    autoSessionTracking: false,
+    beforeSend(event, hint) {
+      if (event.extra?.comfyUIExecutionError) {
+        return event;
+      }
+
+      //TODO (use default pop up behavior).
+      return event;
+    },
+    integrations: [
+      Sentry.childProcessIntegration({
+        breadcrumbs: ['abnormal-exit', 'killed', 'crashed', 'launch-failed', 'oom', 'integrity-failure'],
+        events: ['abnormal-exit', 'killed', 'crashed', 'launch-failed', 'oom', 'integrity-failure'],
+      }),
+    ],
+  });
 
   graphics()
     .then((graphicsInfo) => {
@@ -191,7 +196,6 @@ if (!gotTheLock) {
       sendProgressUpdate('Setting up Python Environment...');
       const pythonEnvironment = new PythonEnvironment(pythonInstallPath, appResourcesPath, spawnPythonAsync);
       await pythonEnvironment.setup();
-
       SetupTray(
         mainWindow,
         basePath,
@@ -221,6 +225,22 @@ if (!gotTheLock) {
         }
       }
     );
+
+    ipcMain.handle(IPC_CHANNELS.GET_ELECTRON_VERSION, () => {
+      return app.getVersion();
+    });
+
+    ipcMain.handle(IPC_CHANNELS.SEND_ERROR_TO_SENTRY, async (_event, { error, extras }): Promise<string | null> => {
+      try {
+        return Sentry.captureMessage(error, {
+          level: 'error',
+          extra: { ...extras, comfyUIExecutionError: true },
+        });
+      } catch (err) {
+        log.error('Failed to send error to Sentry:', err);
+        return null;
+      }
+    });
   });
 }
 

src/preload.ts

@@ -45,6 +45,16 @@ export interface ElectronAPI {
     deleteModel: (filename: string, path: string) => Promise<boolean>;
     getAllDownloads: () => Promise<DownloadItem[]>;
   };
+  /**
+   * Get the current Electron version
+   */
+  getElectronVersion: () => Promise<string>;
+  /**
+   * Send an error message to Sentry
+   * @param error The error object or message to send
+   * @param extras Optional additional context/data to attach
+   */
+  sendErrorToSentry: (error: string, extras?: Record<string, any>) => Promise<void>;
 }
 
 const electronAPI: ElectronAPI = {
@@ -126,6 +136,15 @@ const electronAPI: ElectronAPI = {
       return ipcRenderer.invoke(IPC_CHANNELS.GET_ALL_DOWNLOADS);
     },
   },
+  getElectronVersion: () => {
+    return ipcRenderer.invoke(IPC_CHANNELS.GET_ELECTRON_VERSION);
+  },
+  sendErrorToSentry: (error: string, extras?: Record<string, any>) => {
+    return ipcRenderer.invoke(IPC_CHANNELS.SEND_ERROR_TO_SENTRY, {
+      error: error,
+      extras,
+    });
+  },
 };
 
 contextBridge.exposeInMainWorld(ELECTRON_BRIDGE_API, electronAPI);