feat: enhance Sentry integration with profiling and improved initialization

Author: KatoakDR

electron/main/index.ts

@@ -1,6 +1,5 @@
 import { app } from 'electron';
 import { config as initializeDotenv } from 'dotenv-flow';
-import { initializeApp } from './initialize-app.js';
 import { initializeSentry } from './sentry/initialize-sentry.js';
 
 // Unfortunately in development mode, the app name is 'Electron'.
@@ -13,4 +12,7 @@ app.setAppUserModelId('com.github.dragonrealms-phoenix.phoenix');
 initializeDotenv();
 initializeSentry();
 
+// Wait to initialize the app until the above config and SDK's are ready.
+// Otherwise, the app may use the wrong app name/paths for logs, etc.
+const { initializeApp } = await import('./initialize-app.js');
 await initializeApp();

electron/main/sentry/__tests__/initialize-sentry.test.ts

@@ -29,7 +29,9 @@ describe('initialize-sentry', () => {
 
     expect(mockSentryElectronMain.init).toHaveBeenCalledWith({
       dsn: 'test:sentry:dsn',
+      enableRendererProfiling: true,
       tracesSampleRate: 1,
+      profilesSampleRate: 1,
       normalizeDepth: 5,
       debug: false,
     });

electron/main/sentry/initialize-sentry.ts

@@ -4,13 +4,31 @@ export const initializeSentry = (): void => {
   SentryElectron.init({
     dsn: process.env.SENTRY_DSN,
 
-    // Adjust this value in production, or use tracesSampler for greater control
+    /**
+     * https://docs.sentry.io/platforms/javascript/guides/electron/profiling/browser-profiling/
+     */
+    enableRendererProfiling: true,
+
+    /**
+     * Adjust this to control the sample rate for profiling.
+     * A number between 0.0 and 1.0 (100%).
+     */
     tracesSampleRate: 1,
 
-    // Maximum number of levels JSON logging will traverse in objects and arrays.
+    /**
+     * Sets profiling sample rate when @sentry/profiling-node is installed.
+     * A number between 0.0 and 1.0 (100%).
+     */
+    profilesSampleRate: 1,
+
+    /**
+     * Maximum number of levels JSON logging will traverse in objects and arrays.
+     */
     normalizeDepth: 5,
 
-    // Setting this option to true will print useful information to the console while you're setting up Sentry.
+    /**
+     * Setting this option to true will print useful information to the console while you're setting up Sentry.
+     */
     debug: false,
   });
 };

electron/renderer/sentry.config.ts

@@ -1,17 +1,49 @@
 // Sentry Config for Next.js
 // https://docs.sentry.io/platforms/javascript/guides/nextjs/
 
+import * as SentryElectron from '@sentry/electron/renderer';
 import * as SentryNextjs from '@sentry/nextjs';
 
-SentryNextjs.init({
-  dsn: process.env.SENTRY_DSN,
+SentryElectron.init<
+  SentryElectron.BrowserOptions & SentryNextjs.BrowserOptions
+>(
+  {
+    /**
+     * List of integrations that should be installed after SDK was initialized.
+     * Accepts either a list of integrations or a function that receives
+     * default integrations and returns a new, updated list.
+     * https://docs.sentry.io/platforms/javascript/guides/electron/configuration/integrations/
+     */
+    integrations: (integrations: Array<any>) => {
+      return [
+        ...integrations,
+        SentryElectron.browserTracingIntegration(),
+        SentryElectron.browserProfilingIntegration(),
+        SentryElectron.browserSessionIntegration(),
+      ];
+    },
 
-  // Adjust this value in production, or use tracesSampler for greater control
-  tracesSampleRate: 1,
+    /**
+     * Adjust this to control the sample rate for profiling.
+     * A number between 0.0 and 1.0 (100%).
+     */
+    tracesSampleRate: 1,
 
-  // Maximum number of levels JSON logging will traverse in objects and arrays.
-  normalizeDepth: 5,
+    /**
+     * Sets profiling sample rate when @sentry/profiling-node is installed.
+     * A number between 0.0 and 1.0 (100%).
+     */
+    profilesSampleRate: 1,
 
-  // Setting this option to true will print useful information to the console while you're setting up Sentry.
-  debug: false,
-});
+    /**
+     * Maximum number of levels JSON logging will traverse in objects and arrays.
+     */
+    normalizeDepth: 5,
+
+    /**
+     * Setting this option to true will print useful information to the console while you're setting up Sentry.
+     */
+    debug: false,
+  },
+  SentryNextjs.init
+);

next.config.js

@@ -274,16 +274,16 @@ const nextConfig = {
 };
 
 export default withSentryConfig(nextConfig, {
-  // For all available options, see:
-  // https://github.com/getsentry/sentry-webpack-plugin#options
-
   org: process.env.SENTRY_ORG,
   project: process.env.SENTRY_PROJECT,
   authToken: process.env.SENTRY_AUTH_TOKEN,
 
   release: {
     // e.g. "[email protected]"
     name: `${process.env.npm_package_name}@${process.env.npm_package_version}-${gitHash}`,
+    setCommits: {
+      auto: true,
+    },
   },
 
   // Suppresses source map uploading logs during build.
@@ -292,15 +292,12 @@ export default withSentryConfig(nextConfig, {
   // Don't send internal plugin errors and performance data to Sentry.
   telemetry: false,
 
-  // For all available options, see:
-  // https://docs.sentry.io/platforms/javascript/guides/nextjs/manual-setup/
+  // Automatically tree-shake Sentry logger statements to reduce bundle size.
+  disableLogger: true,
 
   // Upload a larger set of source maps for prettier stack traces (increases build time).
   widenClientFileUpload: true,
 
-  // Automatically tree-shake Sentry logger statements to reduce bundle size.
-  disableLogger: true,
-
   sourcemaps: {
     // Reduce client bundle size by excluding source maps after upload.
     deleteSourcemapsAfterUpload: true,