@sentry/wizard 3.25.2 → 3.26.0

package/src/utils/clack-utils.ts

@@ -15,7 +15,6 @@ import { traceStep } from '../telemetry';
 import {
   detectPackageManger,
   PackageManager,
-  installPackageWithPackageManager,
   packageManagers,
 } from './package-manager';
 import { debug } from './debug';
@@ -23,6 +22,9 @@ import { fulfillsVersionRange } from './semver';
 
 const opn = require('opn') as (
   url: string,
+  options?: {
+    wait?: boolean;
+  },
 ) => Promise<childProcess.ChildProcess>;
 
 export const SENTRY_DOT_ENV_FILE = '.env.sentry-build-plugin';
@@ -383,7 +385,31 @@ export async function installPackage({
     );
 
     try {
-      await installPackageWithPackageManager(packageManager, packageName);
+      await new Promise<void>((resolve, reject) => {
+        childProcess.exec(
+          `${packageManager.installCommand} ${packageName} ${packageManager.flags}`,
+          (err, stdout, stderr) => {
+            if (err) {
+              // Write a log file so we can better troubleshoot issues
+              fs.writeFileSync(
+                path.join(
+                  process.cwd(),
+                  `sentry-wizard-installation-error-${Date.now()}.log`,
+                ),
+                JSON.stringify({
+                  stdout,
+                  stderr,
+                }),
+                { encoding: 'utf8' },
+              );
+
+              reject(err);
+            } else {
+              resolve();
+            }
+          },
+        );
+      });
     } catch (e) {
       sdkInstallSpinner.stop('Installation failed.');
       clack.log.error(
@@ -391,7 +417,7 @@ export async function installPackage({
           'Encountered the following error during installation:',
           // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
         )}\n\n${e}\n\n${chalk.dim(
-          'If you think this issue is caused by the Sentry wizard, let us know here:\nhttps://github.com/getsentry/sentry-wizard/issues',
+          "The wizard has created a `sentry-wizard-installation-error-*.log` file. If you think this issue is caused by the Sentry wizard, create an issue on GitHub and include the log file's content:\nhttps://github.com/getsentry/sentry-wizard/issues",
         )}`,
       );
       await abort();
@@ -614,10 +640,21 @@ SENTRY_AUTH_TOKEN=${authToken}
 }
 
 async function addCliConfigFileToGitIgnore(filename: string): Promise<void> {
-  //TODO: Add a check to see if the file is already ignored in .gitignore
+  const gitignorePath = path.join(process.cwd(), '.gitignore');
+
   try {
+    const gitignoreContent = await fs.promises.readFile(gitignorePath, 'utf8');
+    if (gitignoreContent.split(/\r?\n/).includes(filename)) {
+      clack.log.info(
+        `${chalk.bold('.gitignore')} already has ${chalk.bold(
+          filename,
+        )}. Will not add it again.`,
+      );
+      return;
+    }
+
     await fs.promises.appendFile(
-      path.join(process.cwd(), '.gitignore'),
+      gitignorePath,
       `\n# Sentry Config File\n${filename}\n`,
       { encoding: 'utf8' },
     );
@@ -958,7 +995,7 @@ async function askForWizardLogin(options: {
     )}\n\n${chalk.cyan(urlToOpen)}`,
   );
 
-  opn(urlToOpen).catch(() => {
+  opn(urlToOpen, { wait: false }).catch(() => {
     // opn throws in environments that don't have a browser (e.g. remote shells) so we just noop here
   });
 

package/src/utils/package-manager.ts

@@ -1,8 +1,6 @@
 /* eslint-disable @typescript-eslint/typedef */
-import { exec } from 'child_process';
 import * as fs from 'fs';
 import * as path from 'path';
-import { promisify } from 'util';
 
 import * as Sentry from '@sentry/node';
 import { traceStep } from '../telemetry';
@@ -15,6 +13,7 @@ export interface PackageManager {
   buildCommand: string;
   /* The command that the package manager uses to run a script from package.json */
   runScriptCommand: string;
+  flags: string;
 }
 
 export const BUN: PackageManager = {
@@ -24,6 +23,7 @@ export const BUN: PackageManager = {
   installCommand: 'bun add',
   buildCommand: 'bun run build',
   runScriptCommand: 'bun run',
+  flags: '',
 };
 export const YARN: PackageManager = {
   name: 'yarn',
@@ -32,6 +32,7 @@ export const YARN: PackageManager = {
   installCommand: 'yarn add',
   buildCommand: 'yarn build',
   runScriptCommand: 'yarn',
+  flags: '--ignore-workspace-root-check',
 };
 export const PNPM: PackageManager = {
   name: 'pnpm',
@@ -40,6 +41,7 @@ export const PNPM: PackageManager = {
   installCommand: 'pnpm add',
   buildCommand: 'pnpm build',
   runScriptCommand: 'pnpm',
+  flags: '--ignore-workspace-root-check',
 };
 export const NPM: PackageManager = {
   name: 'npm',
@@ -48,6 +50,7 @@ export const NPM: PackageManager = {
   installCommand: 'npm add',
   buildCommand: 'npm run build',
   runScriptCommand: 'npm run',
+  flags: '',
 };
 
 export const packageManagers = [BUN, YARN, PNPM, NPM];
@@ -64,10 +67,3 @@ export function detectPackageManger(): PackageManager | null {
     return null;
   });
 }
-
-export async function installPackageWithPackageManager(
-  packageManager: PackageManager,
-  packageName: string,
-): Promise<void> {
-  await promisify(exec)(`${packageManager.installCommand} ${packageName}`);
-}

package/test/nextjs/templates.test.ts

@@ -9,6 +9,7 @@ describe('NextJS code templates', () => {
         selfHosted: false,
         sentryUrl: 'https://dont-use-this-url.com',
         tunnelRoute: true,
+        reactComponentAnnotation: false,
       });
 
       expect(template).toMatchInlineSnapshot(`
@@ -56,6 +57,7 @@ describe('NextJS code templates', () => {
         selfHosted: true,
         sentryUrl: 'https://my-sentry.com',
         tunnelRoute: true,
+        reactComponentAnnotation: false,
       });
 
       expect(template).toMatchInlineSnapshot(`
@@ -104,6 +106,7 @@ describe('NextJS code templates', () => {
         selfHosted: false,
         sentryUrl: 'https://dont-use-this-url.com',
         tunnelRoute: false,
+        reactComponentAnnotation: false,
       });
 
       expect(template).toMatchInlineSnapshot(`
@@ -143,5 +146,58 @@ describe('NextJS code templates', () => {
           }"
       `);
     });
+
+    it('adds `reactComponentAnnotations` option if `reactComponentAnnotations` is enabled', () => {
+      const template = getWithSentryConfigOptionsTemplate({
+        orgSlug: 'my-org',
+        projectSlug: 'my-project',
+        selfHosted: false,
+        sentryUrl: 'https://dont-use-this-url.com',
+        tunnelRoute: true,
+        reactComponentAnnotation: true,
+      });
+
+      expect(template).toMatchInlineSnapshot(`
+        "{
+            // For all available options, see:
+            // https://github.com/getsentry/sentry-webpack-plugin#options
+
+            org: "my-org",
+            project: "my-project",
+
+            // Only print logs for uploading source maps in CI
+            silent: !process.env.CI,
+
+            // For all available options, see:
+            // https://docs.sentry.io/platforms/javascript/guides/nextjs/manual-setup/
+
+            // Upload a larger set of source maps for prettier stack traces (increases build time)
+            widenClientFileUpload: true,
+
+            // Automatically annotate React components to show their full name in breadcrumbs and session replay
+            reactComponentAnnotation: {
+              enabled: true,
+            },
+
+            // Route browser requests to Sentry through a Next.js rewrite to circumvent ad-blockers.
+            // This can increase your server load as well as your hosting bill.
+            // Note: Check that the configured route will not match with your Next.js middleware, otherwise reporting of client-
+            // side errors will fail.
+            tunnelRoute: "/monitoring",
+
+            // Hides source maps from generated client bundles
+            hideSourceMaps: true,
+
+            // Automatically tree-shake Sentry logger statements to reduce bundle size
+            disableLogger: true,
+
+            // Enables automatic instrumentation of Vercel Cron Monitors. (Does not yet work with App Router route handlers.)
+            // See the following for more information:
+            // https://docs.sentry.io/product/crons/
+            // https://vercel.com/docs/cron-jobs
+            automaticVercelMonitors: true,
+          }"
+            `);
+    });
   });
 });