@sentry/wizard 3.34.4 → 3.36.0

package/e2e-tests/tests/remix.test.ts

@@ -9,68 +9,122 @@ import {
   checkIfRunsOnProdMode,
   checkPackageJson,
   cleanupGit,
+  createFile,
   KEYS,
+  modifyFile,
   revertLocalChanges,
   startWizardInstance,
   TEST_ARGS,
 } from '../utils';
 import * as path from 'path';
 
-describe('Remix', () => {
-  const integration = Integration.remix;
-  const projectDir = path.resolve(
-    __dirname,
-    '../test-applications/remix-test-app',
-  );
+const SERVER_TEMPLATE = `import { createRequestHandler } from '@remix-run/express';
+import { installGlobals } from '@remix-run/node';
+import compression from 'compression';
+import express from 'express';
+import morgan from 'morgan';
+
+installGlobals();
+
+const viteDevServer =
+  process.env.NODE_ENV === 'production'
+    ? undefined
+    : await import('vite').then(vite =>
+        vite.createServer({
+          server: { middlewareMode: true },
+        }),
+      );
+
+const app = express();
+
+app.use(compression());
+app.disable('x-powered-by');
+
+if (viteDevServer) {
+  app.use(viteDevServer.middlewares);
+} else {
+  app.use('/assets', express.static('build/client/assets', { immutable: true, maxAge: '1y' }));
+}
+
+app.use(express.static('build/client', { maxAge: '1h' }));
+app.use(morgan('tiny'));
+
+app.all(
+  '*',
+  createRequestHandler({
+    build: viteDevServer
+      ? () => viteDevServer.ssrLoadModule('virtual:remix/server-build')
+      : await import('./build/server/index.js'),
+  }),
+);
+
+app.listen(0, () => console.log('Express server listening'));
+`;
 
-  beforeAll(async () => {
-    const wizardInstance = startWizardInstance(integration, projectDir);
-    const packageManagerPrompted = await wizardInstance.waitForOutput(
+
+async function runWizardOnRemixProject(projectDir: string, integration: Integration, fileModificationFn?: (projectDir: string, integration: Integration) => unknown) {
+  const wizardInstance = startWizardInstance(integration, projectDir);
+  let packageManagerPrompted = false;
+
+  if (fileModificationFn) {
+    fileModificationFn(projectDir, integration);
+
+    await wizardInstance.waitForOutput(
+      'Do you want to continue anyway?',
+    );
+
+    packageManagerPrompted = await wizardInstance.sendStdinAndWaitForOutput(
+      [KEYS.ENTER],
       'Please select your package manager.',
     );
+  } else {
 
-    const tracingOptionPrompted =
-      packageManagerPrompted &&
-      (await wizardInstance.sendStdinAndWaitForOutput(
-        // Selecting `yarn` as the package manager
-        [KEYS.DOWN, KEYS.ENTER],
-        // "Do you want to enable Tracing", sometimes doesn't work as `Tracing` can be printed in bold.
-        'to track the performance of your application?',
-        {
-          timeout: 240_000,
-        },
-      ));
-
-    const replayOptionPrompted =
-      tracingOptionPrompted &&
-      (await wizardInstance.sendStdinAndWaitForOutput(
-        [KEYS.ENTER],
-        // "Do you want to enable Sentry Session Replay", sometimes doesn't work as `Sentry Session Replay` can be printed in bold.
-        'to get a video-like reproduction of errors during a user session?',
-      ));
-
-    replayOptionPrompted &&
-      (await wizardInstance.sendStdinAndWaitForOutput(
-        [KEYS.ENTER],
-        'Do you want to create an example page',
-        {
-          optional: true,
-        },
-      ));
-
-    await wizardInstance.sendStdinAndWaitForOutput(
-      [KEYS.ENTER, KEYS.ENTER],
-      'Sentry has been successfully configured for your Remix project',
+    packageManagerPrompted = await wizardInstance.waitForOutput(
+      'Please select your package manager.',
     );
+  }
 
-    wizardInstance.kill();
-  });
+  const tracingOptionPrompted =
+    packageManagerPrompted &&
+    (await wizardInstance.sendStdinAndWaitForOutput(
+      // Selecting `yarn` as the package manager
+      [KEYS.DOWN, KEYS.ENTER],
+      // "Do you want to enable Tracing", sometimes doesn't work as `Tracing` can be printed in bold.
+      'to track the performance of your application?',
+      {
+        timeout: 240_000,
+      },
+    ));
 
-  afterAll(() => {
-    revertLocalChanges(projectDir);
-    cleanupGit(projectDir);
-  });
+  const replayOptionPrompted =
+    tracingOptionPrompted &&
+    (await wizardInstance.sendStdinAndWaitForOutput(
+      [KEYS.ENTER],
+      // "Do you want to enable Sentry Session Replay", sometimes doesn't work as `Sentry Session Replay` can be printed in bold.
+      'to get a video-like reproduction of errors during a user session?',
+    ));
+
+  replayOptionPrompted &&
+    (await wizardInstance.sendStdinAndWaitForOutput(
+      [KEYS.ENTER],
+      'Do you want to create an example page',
+      {
+        optional: true,
+      },
+    ));
 
+  await wizardInstance.sendStdinAndWaitForOutput(
+    [KEYS.ENTER, KEYS.ENTER],
+    'Sentry has been successfully configured for your Remix project',
+  );
+
+  wizardInstance.kill();
+};
+
+function checkRemixProject(projectDir: string, integration: Integration, options?: {
+  devModeExpectedOutput?: string;
+  prodModeExpectedOutput?: string;
+}) {
   test('package.json is updated correctly', () => {
     checkPackageJson(projectDir, integration);
   });
@@ -140,15 +194,74 @@ describe('Remix', () => {
     ]);
   });
 
-  test('builds correctly', async () => {
+  test('builds successfully', async () => {
     await checkIfBuilds(projectDir, 'built');
   });
 
   test('runs on dev mode correctly', async () => {
-    await checkIfRunsOnDevMode(projectDir, 'to expose');
+    await checkIfRunsOnDevMode(projectDir, options?.devModeExpectedOutput || 'to expose');
   });
 
   test('runs on prod mode correctly', async () => {
-    await checkIfRunsOnProdMode(projectDir, '[remix-serve]');
+    await checkIfRunsOnProdMode(projectDir, options?.prodModeExpectedOutput || '[remix-serve]');
+  });
+}
+
+describe('Remix', () => {
+  describe('with empty project', () => {
+    const integration = Integration.remix;
+    const projectDir = path.resolve(
+      __dirname,
+      '../test-applications/remix-test-app',
+    );
+
+    beforeAll(async () => {
+      await runWizardOnRemixProject(projectDir, integration);
+    });
+
+    afterAll(() => {
+      revertLocalChanges(projectDir);
+      cleanupGit(projectDir);
+    });
+
+    checkRemixProject(projectDir, integration);
+  });
+
+  describe('with existing custom Express server', () => {
+    const integration = Integration.remix;
+    const projectDir = path.resolve(
+      __dirname,
+      '../test-applications/remix-test-app',
+    );
+
+    beforeAll(async () => {
+      await runWizardOnRemixProject(projectDir, integration, (projectDir) => {
+        createFile(
+          `${projectDir}/server.mjs`,
+          SERVER_TEMPLATE,
+        );
+
+        modifyFile(`${projectDir}/package.json`, {
+          '"start": "remix-serve ./build/server/index.js"': '"start": "node ./server.mjs"',
+          '"dev": "remix vite:dev"': '"dev": "node ./server.mjs"',
+        });
+      });
+    });
+
+    afterAll(() => {
+      revertLocalChanges(projectDir);
+      cleanupGit(projectDir);
+    });
+
+    checkRemixProject(projectDir, integration, {
+      devModeExpectedOutput: 'Express server listening',
+      prodModeExpectedOutput: 'Express server listening',
+    });
+
+    test('server.mjs contains instrumentation file import', () => {
+      checkFileContents(`${projectDir}/server.mjs`, [
+        "import './instrumentation.server.mjs';",
+      ]);
+    });
   });
 });

package/e2e-tests/tests/sveltekit.test.ts

@@ -9,6 +9,7 @@ import {
   checkIfRunsOnProdMode,
   checkPackageJson,
   cleanupGit,
+  createFile,
   KEYS,
   revertLocalChanges,
   startWizardInstance,
@@ -16,65 +17,93 @@ import {
 } from '../utils';
 import * as path from 'path';
 
-describe('Sveltekit', () => {
-  const integration = Integration.sveltekit;
-  const projectDir = path.resolve(
-    __dirname,
-    '../test-applications/sveltekit-test-app',
-  );
-
-  beforeAll(async () => {
-    const wizardInstance = startWizardInstance(integration, projectDir);
+const SERVER_HOOK_TEMPLATE = `import type { Handle } from '@sveltejs/kit';
+
+export const handle: Handle = async ({ event, resolve }) => {
+	if (event.url.pathname.startsWith('/custom')) {
+		return new Response('custom response');
+	}
+
+	const response = await resolve(event);
+	return response;
+};
+`;
+const CLIENT_HOOK_TEMPLATE = `
+export async function handleError({ error, event }) {
+  // you can capture the \`error\` and \`event\` from the client
+  // but it only runs if the unexpected error comes from \`+ page.ts\`
+  console.log(error)
+
+  return {
+    // don't show sensitive data to the user
+    message: 'Yikes! 💩',
+  }
+}
+`;
+
+async function runWizardOnSvelteKitProject(projectDir: string, integration: Integration, fileModificationFn?: (projectDir: string, integration: Integration) => unknown) {
+  const wizardInstance = startWizardInstance(integration, projectDir);
+  let packageManagerPrompted = false;
+
+  if (fileModificationFn) {
+    fileModificationFn(projectDir, integration);
+
+    // As we modified project, we have a warning prompt before we get the package manager prompt
+    await wizardInstance.waitForOutput(
+      'Do you want to continue anyway?',
+    );
 
-    const packageManagerPrompted = await wizardInstance.waitForOutput(
+    packageManagerPrompted = await wizardInstance.sendStdinAndWaitForOutput(
+      [KEYS.ENTER],
       'Please select your package manager.',
-      {
-        optional: true,
-      }
     );
-
-    const tracingOptionPrompted =
-      packageManagerPrompted &&
-      (await wizardInstance.sendStdinAndWaitForOutput(
-        // Selecting `yarn` as the package manager
-        [KEYS.DOWN, KEYS.ENTER],
-        // "Do you want to enable Tracing", sometimes doesn't work as `Tracing` can be printed in bold.
-        'to track the performance of your application?',
-        {
-          timeout: 240_000,
-        }
-      ));
-
-    const replayOptionPrompted =
-      tracingOptionPrompted &&
-      (await wizardInstance.sendStdinAndWaitForOutput(
-        [KEYS.ENTER],
-        // "Do you want to enable Sentry Session Replay", sometimes doesn't work as `Sentry Session Replay` can be printed in bold.
-        'to get a video-like reproduction of errors during a user session?',
-      ));
-
-    replayOptionPrompted &&
-      (await wizardInstance.sendStdinAndWaitForOutput(
-        [KEYS.ENTER],
-        'Do you want to create an example page',
-        {
-          optional: true,
-        },
-      ));
-
-    await wizardInstance.sendStdinAndWaitForOutput(
-      [KEYS.ENTER, KEYS.ENTER],
-      'Successfully installed the Sentry SvelteKit SDK!',
+  } else {
+    packageManagerPrompted = await wizardInstance.waitForOutput(
+      'Please select your package manager'
     );
+  }
+
+  const tracingOptionPrompted =
+    packageManagerPrompted &&
+    (await wizardInstance.sendStdinAndWaitForOutput(
+      // Selecting `yarn` as the package manager
+      [KEYS.DOWN, KEYS.ENTER],
+      // "Do you want to enable Tracing", sometimes doesn't work as `Tracing` can be printed in bold.
+      'to track the performance of your application?',
+      {
+        timeout: 240_000,
+      }
+    ));
+
+  const replayOptionPrompted =
+    tracingOptionPrompted &&
+    (await wizardInstance.sendStdinAndWaitForOutput(
+      [KEYS.ENTER],
+      // "Do you want to enable Sentry Session Replay", sometimes doesn't work as `Sentry Session Replay` can be printed in bold.
+      'to get a video-like reproduction of errors during a user session?',
+    ));
+
+  replayOptionPrompted &&
+    (await wizardInstance.sendStdinAndWaitForOutput(
+      [KEYS.ENTER],
+      'Do you want to create an example page',
+      {
+        optional: true,
+      },
+    ));
 
-    wizardInstance.kill();
-  });
+  await wizardInstance.sendStdinAndWaitForOutput(
+    [KEYS.ENTER, KEYS.ENTER],
+    'Successfully installed the Sentry SvelteKit SDK!',
+  );
 
-  afterAll(() => {
-    revertLocalChanges(projectDir);
-    cleanupGit(projectDir);
-  });
+  wizardInstance.kill();
+}
 
+function checkSvelteKitProject(projectDir: string, integration: Integration, options?: {
+  devModeExpectedOutput: string;
+  prodModeExpectedOutput: string;
+}) {
   test('should have the correct package.json', () => {
     checkPackageJson(projectDir, integration);
   });
@@ -99,11 +128,43 @@ describe('Sveltekit', () => {
     checkFileExists(path.resolve(projectDir, 'src/hooks.client.ts'));
   });
 
-  test('hooks.client.ts contains sentry import', () => {
-    checkFileContents(
-      path.resolve(projectDir, 'src/hooks.client.ts'),
-      [`import * as Sentry from '@sentry/sveltekit';`,
-        `Sentry.init({
+  test('builds successfully', async () => {
+    await checkIfBuilds(projectDir, 'Successfully uploaded source maps to Sentry');
+  });
+
+  test('runs on dev mode correctly', async () => {
+    await checkIfRunsOnDevMode(projectDir, options?.devModeExpectedOutput || 'ready in');
+  });
+
+  test('runs on prod mode correctly', async () => {
+    await checkIfRunsOnProdMode(projectDir, options?.prodModeExpectedOutput || 'to expose', 'preview');
+  });
+}
+
+describe('Sveltekit', () => {
+  describe('without existing hooks', () => {
+    const integration = Integration.sveltekit;
+    const projectDir = path.resolve(
+      __dirname,
+      '../test-applications/sveltekit-test-app',
+    );
+
+    beforeAll(async () => {
+      await runWizardOnSvelteKitProject(projectDir, integration);
+    });
+
+    afterAll(() => {
+      revertLocalChanges(projectDir);
+      cleanupGit(projectDir);
+    });
+
+    checkSvelteKitProject(projectDir, integration);
+
+    test('hooks.client.ts contains sentry', () => {
+      checkFileContents(
+        path.resolve(projectDir, 'src/hooks.client.ts'),
+        [`import * as Sentry from '@sentry/sveltekit';`,
+          `Sentry.init({
   dsn: '${TEST_ARGS.PROJECT_DSN}',
 
   tracesSampleRate: 1.0,
@@ -118,37 +179,77 @@ describe('Sveltekit', () => {
 
   // If you don't want to use Session Replay, just remove the line below:
   integrations: [replayIntegration()],
-});`]);
-  });
-
-
-  test('hooks.server.ts contains sentry import', () => {
-    checkFileContents(
-      path.resolve(projectDir, 'src/hooks.server.ts'),
-      [
-        `import * as Sentry from '@sentry/sveltekit';`,
-        `Sentry.init({
+});`, 'export const handleError = handleErrorWithSentry(']);
+    });
+
+    test('hooks.server.ts contains sentry', () => {
+      checkFileContents(
+        path.resolve(projectDir, 'src/hooks.server.ts'),
+        [
+          `import * as Sentry from '@sentry/sveltekit';`,
+          `Sentry.init({
   dsn: '${TEST_ARGS.PROJECT_DSN}',
 
   tracesSampleRate: 1.0,
 
   // uncomment the line below to enable Spotlight (https://spotlightjs.com)
   // spotlight: import.meta.env.DEV,
-});`])
-  });
-
-
-  test('runs on dev mode correctly', async () => {
-    await checkIfRunsOnDevMode(projectDir, 'ready in');
+});`, 'export const handleError = handleErrorWithSentry();']);
+    });
   });
 
-  test('should build successfully', async () => {
-    await checkIfBuilds(projectDir, 'Successfully uploaded source maps to Sentry');
-  });
+  describe('with existing hooks', () => {
+    const integration = Integration.sveltekit;
+    const projectDir = path.resolve(
+      __dirname,
+      '../test-applications/sveltekit-test-app',
+    );
 
-  test('runs on prod mode correctly', async () => {
-    // We can't use the full prompt `Network: use--host to expose` as `--host` can be printed in bold.
-    await checkIfRunsOnProdMode(projectDir, 'to expose', "preview");
+    beforeAll(async () => {
+      await runWizardOnSvelteKitProject(projectDir, integration, (projectDir) => {
+        createFile(
+          path.resolve(projectDir, 'src/hooks.server.ts'),
+          SERVER_HOOK_TEMPLATE,
+        )
+
+        createFile(
+          path.resolve(projectDir, 'src/hooks.client.ts'),
+          CLIENT_HOOK_TEMPLATE,
+        )
+      });
+    });
+
+    afterAll(() => {
+      revertLocalChanges(projectDir);
+      cleanupGit(projectDir);
+    });
+
+    checkSvelteKitProject(projectDir, integration);
+
+    // These are removed from the common tests as the content is different
+    // when the hooks are merged instead of created from the template
+    test('hooks.client.ts contains sentry instrumentation', () => {
+      checkFileContents(
+        path.resolve(projectDir, 'src/hooks.client.ts'),
+        [`import * as Sentry from '@sentry/sveltekit';`,
+          `Sentry.init({
+    dsn: "${TEST_ARGS.PROJECT_DSN}",
+    tracesSampleRate: 1,
+    replaysSessionSampleRate: 0.1,
+    replaysOnErrorSampleRate: 1,
+    integrations: [Sentry.replayIntegration()]
+})`, 'export const handleError = Sentry.handleErrorWithSentry(']);
+    });
+
+    test('hooks.server.ts contains sentry init', () => {
+      checkFileContents(
+        path.resolve(projectDir, 'src/hooks.server.ts'),
+        [`import * as Sentry from '@sentry/sveltekit';`,
+          `Sentry.init({
+    dsn: "${TEST_ARGS.PROJECT_DSN}",
+    tracesSampleRate: 1
+})`, 'export const handleError = Sentry.handleErrorWithSentry();']);
+    });
   });
 });
 

package/e2e-tests/utils/index.ts

@@ -227,11 +227,42 @@ export function startWizardInstance(
 }
 
 /**
- * Read the file contents and check if it contains the given content
+ * Create a file with the given content
  *
  * @param filePath
  * @param content
  */
+export function createFile(filePath: string, content?: string) {
+  return fs.writeFileSync(filePath, content || '');
+}
+
+/**
+ * Modify the file with the new content
+ *
+ * @param filePath
+ * @param oldContent
+ * @param newContent
+ */
+export function modifyFile(
+  filePath: string,
+  replaceMap: Record<string, string>,
+) {
+  const fileContent = fs.readFileSync(filePath, 'utf-8');
+  let newFileContent = fileContent;
+
+  for (const [oldContent, newContent] of Object.entries(replaceMap)) {
+    newFileContent = newFileContent.replace(oldContent, newContent);
+  }
+
+  fs.writeFileSync(filePath, newFileContent);
+}
+
+/**
+ * Read the file contents and check if it contains the given content
+ *
+ * @param {string} filePath
+ * @param {(string | string[])} content
+ */
 export function checkFileContents(
   filePath: string,
   content: string | string[],
@@ -255,6 +286,7 @@ export function checkFileExists(filePath: string) {
 
 /**
  * Check if the package.json contains the given integration
+ *
  * @param projectDir
  * @param integration
  */
@@ -264,6 +296,7 @@ export function checkPackageJson(projectDir: string, integration: Integration) {
 
 /**
  * Check if the .sentryclirc contains the auth token
+ *
  * @param projectDir
  */
 export function checkSentryCliRc(projectDir: string) {

package/lib/Constants.ts

@@ -6,6 +6,7 @@ export enum Integration {
   cordova = 'cordova',
   electron = 'electron',
   nextjs = 'nextjs',
+  nuxt = 'nuxt',
   remix = 'remix',
   sveltekit = 'sveltekit',
   sourcemaps = 'sourcemaps',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/wizard",
-  "version": "3.34.4",
+  "version": "3.36.0",
   "homepage": "https://github.com/getsentry/sentry-wizard",
   "repository": "https://github.com/getsentry/sentry-wizard",
   "description": "Sentry wizard helping you to configure your project",

package/src/android/templates.ts

@@ -33,8 +33,6 @@ export const manifest = (dsn: string) => `
 
     <!-- enable the performance API by setting a sample-rate, adjust in production env -->
     <meta-data android:name="io.sentry.traces.sample-rate" android:value="1.0" />
-    <!-- enable profiling when starting transactions, adjust in production env -->
-    <meta-data android:name="io.sentry.traces.profiling.sample-rate" android:value="1.0" />
 `;
 
 export const sentryImport = `import io.sentry.Sentry;\n`;

package/src/apple/templates.ts

@@ -20,7 +20,13 @@ export function getSwiftSnippet(dsn: string): string {
   return `        SentrySDK.start { options in
             options.dsn = "${dsn}"
             options.debug = true // Enabled debug when first installing is always helpful
-            options.enableTracing = true 
+            // Set tracesSampleRate to 1.0 to capture 100% of transactions for performance monitoring.
+            // We recommend adjusting this value in production.
+            options.tracesSampleRate = 1.0
+
+            // Sample rate for profiling, applied on top of TracesSampleRate.
+            // We recommend adjusting this value in production.
+            options.profilesSampleRate = 1.0 
 
             // Uncomment the following lines to add more data to your events
             // options.attachScreenshot = true // This adds a screenshot to the error events
@@ -34,7 +40,13 @@ export function getObjcSnippet(dsn: string): string {
   return `    [SentrySDK startWithConfigureOptions:^(SentryOptions * options) {
         options.dsn = @"${dsn}";
         options.debug = YES; // Enabled debug when first installing is always helpful
-        options.enableTracing = YES;
+        // Set tracesSampleRate to 1.0 to capture 100% of transactions for performance monitoring.
+        // We recommend adjusting this value in production.
+        options.tracesSampleRate = @1.0;
+
+        // Sample rate for profiling, applied on top of TracesSampleRate.
+        // We recommend adjusting this value in production.
+        options.profilesSampleRate = @1.0;
 
         //Uncomment the following lines to add more data to your events
         //options.attachScreenshot = YES; //This will add a screenshot to the error events

package/src/nextjs/nextjs-wizard.ts

@@ -94,6 +94,7 @@ export async function runNextjsWizardWithTelemetry(
   const { packageManager: packageManagerFromInstallStep } =
     await installPackage({
       packageName: '@sentry/nextjs@^8',
+      packageNameDisplayLabel: '@sentry/nextjs',
       alreadyInstalled: !!packageJson?.dependencies?.['@sentry/nextjs'],
     });