add sentry error handling

.github/workflows/ci.yml

@@ -74,3 +74,6 @@ jobs:
       ES_PASSWORD: ${{ secrets.ES_PASSWORD }}
       WINDOWS_CREDENTIAL_ID_SIGNER: ${{ secrets.WINDOWS_CREDENTIAL_ID_SIGNER }}
       ES_TOTP_SECRET: ${{ secrets.ES_TOTP_SECRET }}
+      # Sentry AUTH Token
+      SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
+      SENTRY_DSN: ${{ secrets.SENTRY_DSN }}

.github/workflows/release.yml

@@ -52,7 +52,12 @@ on:
       ES_TOTP_SECRET:
         description: 'Password to decrypt the certificate file'
         required: true
-
+      SENTRY_AUTH_TOKEN:
+        description: 'Sentry auth token'
+        required: true
+      SENTRY_DSN:
+        description: 'Sentry DSN to perform the requests'
+        required: true
 concurrency:
   group: release-${{ github.ref }}
   cancel-in-progress: true
@@ -92,6 +97,9 @@ jobs:
           VITE_SEGMENT_CREATORS_HUB_API_KEY: ${{ secrets.VITE_SEGMENT_CREATORS_HUB_API_KEY }}
           VITE_SEGMENT_INSPECTOR_API_KEY: ${{ secrets.VITE_SEGMENT_INSPECTOR_API_KEY }}
           VITE_ALLOWED_EXTERNAL_ORIGINS: ${{ secrets.VITE_ALLOWED_EXTERNAL_ORIGINS }}
+          # Sentry AUTH Token
+          SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
+          VITE_SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
 
       - name: Generate release version
         id: version

package.json

@@ -34,6 +34,7 @@
   },
   "devDependencies": {
     "@reduxjs/toolkit": "^2.2.6",
+    "@sentry/wizard": "^4.2.0",
     "@types/cmd-shim": "^5.0.2",
     "@types/is-running": "^2.1.2",
     "@types/node": "20.14.9",
@@ -74,6 +75,9 @@
     "@dcl/sdk": "7.7.9",
     "@ethersproject/hash": "^5.7.0",
     "@segment/analytics-node": "^2.1.2",
+    "@sentry/electron": "^6.1.0",
+    "@sentry/react": "^9.5.0",
+    "@sentry/vite-plugin": "^3.2.2",
     "cmd-shim": "^6.0.3",
     "decentraland-connect": "^7.1.0",
     "decentraland-crypto-fetch": "^2.0.1",

packages/main/src/index.ts

@@ -1,4 +1,5 @@
 import { app } from 'electron';
+import * as Sentry from '@sentry/electron/main';
 import { platform } from 'node:process';
 import updater from 'electron-updater';
 import log from 'electron-log/main';
@@ -14,6 +15,12 @@ import '/@/security-restrictions';
 
 log.initialize();
 
+if (import.meta.env.PROD) {
+  Sentry.init({
+    dsn: import.meta.env.VITE_SENTRY_DSN,
+  });
+}
+
 /**
  * Prevent electron from running multiple instances.
  */
@@ -91,14 +98,24 @@ if (import.meta.env.PROD) {
         log.info(`[AutoUpdater] Download progress ${info.percent.toFixed(2)}%`);
       });
       updater.autoUpdater.on('error', err => {
+        Sentry.captureException(err, {
+          tags: { source: 'auto-updater' },
+          extra: { context: 'Electron auto-update process' },
+        });
         log.error('[AutoUpdater] Error in auto-updater', err);
       });
       return updater.autoUpdater.checkForUpdatesAndNotify({
         title: 'Update available',
         body: 'New version was installed. Restart the app to apply changes.',
       });
     })
-    .catch(error => log.error('[AutoUpdater] Failed check and install updates:', error.message));
+    .catch(error => {
+      Sentry.captureException(error, {
+        tags: { source: 'auto-updater' },
+        extra: { context: 'Electron auto-update process main' },
+      });
+      log.error('[AutoUpdater] Failed check and install updates:', error.message);
+    });
 } else {
   log.info('Skipping updates check in DEV mode');
 }
@@ -119,6 +136,10 @@ app.on('before-quit', async event => {
   try {
     await killAll();
   } catch (error) {
+    Sentry.captureException(error, {
+      tags: { source: 'before-quit' },
+      extra: { context: 'Before quit error' },
+    });
     log.error('[App] Failed to kill all servers:', error);
   }
   log.info('[App] Quit');

packages/main/src/modules/handle.ts

@@ -1,5 +1,7 @@
 import { ipcMain } from 'electron';
 import log from 'electron-log';
+import * as Sentry from '@sentry/electron/main';
+
 import type { Ipc, IpcError, IpcResult } from '/shared/types/ipc';
 
 // wrapper for ipcMain.handle with types
@@ -20,6 +22,10 @@ export async function handle<T extends keyof Ipc>(
       return result;
     } catch (error: any) {
       log.error(`[IPC] channel=${channel} error=${error.message}`);
+      Sentry.captureException(error, {
+        tags: { source: 'ipc-handle' },
+        extra: { channel },
+      });
       const result: IpcError = {
         success: false,
         error: error.message,

packages/main/src/modules/migrations.ts

@@ -1,4 +1,5 @@
 import path from 'path';
+import * as Sentry from '@sentry/electron/main';
 import fs from 'fs/promises';
 import log from 'electron-log/main';
 import { future } from 'fp-future';
@@ -23,6 +24,9 @@ export async function runMigrations() {
     log.info('[Migrations] Migrations completed');
     migrationsFuture.resolve();
   } catch (error) {
+    Sentry.captureException(error, {
+      tags: { source: 'migrations' },
+    });
     const err = error instanceof Error ? error : new Error(String(error));
     migrationsFuture.reject(err);
     throw error;

packages/main/vite.config.js

@@ -1,3 +1,4 @@
+import { sentryVitePlugin } from '@sentry/vite-plugin';
 import { node } from '../../.electron-vendors.cache.json';
 import { join } from 'node:path';
 
@@ -37,6 +38,13 @@ const config = {
     emptyOutDir: true,
     reportCompressedSize: false,
   },
+  plugins: [
+    sentryVitePlugin({
+      org: 'decentraland',
+      project: 'creator-hub',
+      disable: process.env.MODE === 'development' || process.env.DRY_RUN,
+    }),
+  ],
 };
 
 export default config;

packages/preload/vite.config.js

@@ -1,3 +1,4 @@
+import { sentryVitePlugin } from '@sentry/vite-plugin';
 import { chrome } from '../../.electron-vendors.cache.json';
 import { preload } from 'unplugin-auto-expose';
 import { join } from 'node:path';
@@ -39,8 +40,14 @@ const config = {
     emptyOutDir: true,
     reportCompressedSize: false,
   },
-
-  plugins: [preload.vite()],
+  plugins: [
+    preload.vite(),
+    sentryVitePlugin({
+      org: 'decentraland',
+      project: 'creator-hub',
+      disable: process.env.MODE === 'development' || process.env.DRY_RUN,
+    }),
+  ],
 };
 
 export default config;

packages/renderer/src/index.tsx

@@ -24,11 +24,32 @@ import { DocsPage } from '/@/components/DocsPage';
 import { Install } from '/@/components/Install';
 import { Snackbar } from '/@/components/Snackbar';
 
+import { init as reactInit } from '@sentry/react';
+import {
+  init as SentryInit,
+  browserTracingIntegration,
+  replayIntegration,
+} from '@sentry/electron/renderer';
+
 import '/@/themes';
 
 const container = document.getElementById('app')!;
 const root = createRoot(container);
 
+if (import.meta.env.PROD) {
+  SentryInit(
+    {
+      integrations: [browserTracingIntegration(), replayIntegration()],
+      release: import.meta.env.VITE_APP_VERSION,
+      tracesSampleRate: 0.001,
+      replaysSessionSampleRate: 0.01,
+      replaysOnErrorSampleRate: 0.01,
+      enabled: import.meta.env.PROD,
+    },
+    reactInit as any,
+  );
+}
+
 root.render(
   <React.StrictMode>
     <StoreProvider store={store}>

packages/renderer/vite.config.js

@@ -1,5 +1,6 @@
 /* eslint-env node */
 
+import { sentryVitePlugin } from '@sentry/vite-plugin';
 import { chrome } from '../../.electron-vendors.cache.json';
 import react from '@vitejs/plugin-react';
 import { renderer } from 'unplugin-auto-expose';
@@ -49,6 +50,11 @@ const config = {
     renderer.vite({
       preloadEntry: join(PACKAGE_ROOT, '../preload/src/index.ts'),
     }),
+    sentryVitePlugin({
+      org: 'decentraland',
+      project: 'creator-hub',
+      disable: process.env.MODE === 'development' || process.env.DRY_RUN,
+    }),
   ],
 };