@sentry/wizard 3.7.0 → 3.8.0

package/src/apple/xcode-manager.ts

@@ -3,145 +3,162 @@
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
 /* eslint-disable @typescript-eslint/no-unsafe-call */
 /* eslint-disable @typescript-eslint/no-unused-vars */
-import { SentryCli } from '../../lib/Helper/SentryCli';
-// @ts-ignore - clack is ESM and TS complains about that. It works though
-import clack from '@clack/prompts';
-import chalk from 'chalk';
 import * as fs from 'fs';
-import * as path from 'path';
+import { SentryProjectData } from '../utils/types';
 import * as templates from './templates';
 const xcode = require('xcode');
 
-import { SentryProjectData } from '../utils/clack-utils';
 /* eslint-enable @typescript-eslint/no-unused-vars */
 
 function setDebugInformationFormat(proj: any): void {
-    const xcObjects = proj.hash.project.objects;
-    const target = proj.getFirstTarget().firstTarget;
-
-    xcObjects.XCConfigurationList[target.buildConfigurationList].buildConfigurations.forEach((buildConfig: { value: string }) => {
-        xcObjects.XCBuildConfiguration[buildConfig.value].buildSettings.DEBUG_INFORMATION_FORMAT = "\"dwarf-with-dsym\"";
-    });
+  const xcObjects = proj.hash.project.objects;
+  const target = proj.getFirstTarget().firstTarget;
+
+  xcObjects.XCConfigurationList[
+    target.buildConfigurationList
+  ].buildConfigurations.forEach((buildConfig: { value: string }) => {
+    xcObjects.XCBuildConfiguration[
+      buildConfig.value
+    ].buildSettings.DEBUG_INFORMATION_FORMAT = '"dwarf-with-dsym"';
+  });
 }
 
 function addSentrySPM(proj: any): void {
-    const xcObjects = proj.hash.project.objects;
-
-    const sentryFrameworkUUID = proj.generateUuid() as string;
-    const sentrySPMUUID = proj.generateUuid() as string;
-
-    //Check whether xcObjects already have sentry framework
-    if (xcObjects.PBXFrameworksBuildPhase) {
-        for (const key in xcObjects.PBXFrameworksBuildPhase || {}) {
-            if (!key.endsWith("_comment")) {
-                const frameworks = xcObjects.PBXFrameworksBuildPhase[key].files;
-                for (const framework of frameworks) {
-                    if (framework.comment === "Sentry in Frameworks") {
-                        return;
-                    }
-                }
-            }
-        }
-    }
+  const xcObjects = proj.hash.project.objects;
 
-    xcObjects.PBXBuildFile[sentryFrameworkUUID] = {
-        isa: "PBXBuildFile",
-        productRef: sentrySPMUUID,
-        productRef_comment: "Sentry",
-    };
-    xcObjects.PBXBuildFile[sentryFrameworkUUID + "_comment"] = "Sentry in Frameworks";
+  const sentryFrameworkUUID = proj.generateUuid() as string;
+  const sentrySPMUUID = proj.generateUuid() as string;
 
+  //Check whether xcObjects already have sentry framework
+  if (xcObjects.PBXFrameworksBuildPhase) {
     for (const key in xcObjects.PBXFrameworksBuildPhase || {}) {
-        if (!key.endsWith("_comment")) {
-            const frameworks = xcObjects.PBXFrameworksBuildPhase[key].files;
-            frameworks.push({
-                value: sentryFrameworkUUID,
-                comment: "Sentry in Frameworks",
-            });
+      if (!key.endsWith('_comment')) {
+        const frameworks = xcObjects.PBXFrameworksBuildPhase[key].files;
+        for (const framework of frameworks) {
+          if (framework.comment === 'Sentry in Frameworks') {
+            return;
+          }
         }
+      }
     }
-
-    const target = proj.getFirstTarget().firstTarget;
-    if (!target.packageProductDependencies) {
-        target.packageProductDependencies = [];
+  }
+
+  xcObjects.PBXBuildFile[sentryFrameworkUUID] = {
+    isa: 'PBXBuildFile',
+    productRef: sentrySPMUUID,
+    productRef_comment: 'Sentry',
+  };
+  xcObjects.PBXBuildFile[sentryFrameworkUUID + '_comment'] =
+    'Sentry in Frameworks';
+
+  for (const key in xcObjects.PBXFrameworksBuildPhase || {}) {
+    if (!key.endsWith('_comment')) {
+      const frameworks = xcObjects.PBXFrameworksBuildPhase[key].files;
+      frameworks.push({
+        value: sentryFrameworkUUID,
+        comment: 'Sentry in Frameworks',
+      });
     }
-    target.packageProductDependencies.push({
-        value: sentrySPMUUID,
-        comment: "Sentry",
-    });
-
-    const sentrySwiftPackageUUID = proj.generateUuid() as string;
-    const xcProject = proj.getFirstProject().firstProject;
-    if (!xcProject.packageReferences) {
-        xcProject.packageReferences = [];
-    }
-    xcProject.packageReferences.push({
-        value: sentrySwiftPackageUUID,
-        comment: "XCRemoteSwiftPackageReference \"sentry-cocoa\"",
-    });
-
-    xcObjects.XCRemoteSwiftPackageReference = {};
-    xcObjects.XCRemoteSwiftPackageReference[sentrySwiftPackageUUID] = {
-        isa: "XCRemoteSwiftPackageReference",
-        repositoryURL: "\"https://github.com/getsentry/sentry-cocoa/\"",
-        requirement: {
-            kind: "upToNextMajorVersion",
-            minimumVersion: "8.0.0",
-        }
-    };
-    xcObjects.XCRemoteSwiftPackageReference[sentrySwiftPackageUUID + "_comment"] = "XCRemoteSwiftPackageReference \"sentry-cocoa\"";
-
-    xcObjects.XCSwiftPackageProductDependency = {};
-    xcObjects.XCSwiftPackageProductDependency[sentrySPMUUID] =
-    {
-        isa: "XCSwiftPackageProductDependency",
-        package: sentrySwiftPackageUUID,
-        package_comment: "XCRemoteSwiftPackageReference \"sentry-cocoa\"",
-        productName: "Sentry",
-    };
-    xcObjects.XCSwiftPackageProductDependency[sentrySPMUUID + "_comment"] = "Sentry";
+  }
+
+  const target = proj.getFirstTarget().firstTarget;
+  if (!target.packageProductDependencies) {
+    target.packageProductDependencies = [];
+  }
+  target.packageProductDependencies.push({
+    value: sentrySPMUUID,
+    comment: 'Sentry',
+  });
+
+  const sentrySwiftPackageUUID = proj.generateUuid() as string;
+  const xcProject = proj.getFirstProject().firstProject;
+  if (!xcProject.packageReferences) {
+    xcProject.packageReferences = [];
+  }
+  xcProject.packageReferences.push({
+    value: sentrySwiftPackageUUID,
+    comment: 'XCRemoteSwiftPackageReference "sentry-cocoa"',
+  });
+
+  xcObjects.XCRemoteSwiftPackageReference = {};
+  xcObjects.XCRemoteSwiftPackageReference[sentrySwiftPackageUUID] = {
+    isa: 'XCRemoteSwiftPackageReference',
+    repositoryURL: '"https://github.com/getsentry/sentry-cocoa/"',
+    requirement: {
+      kind: 'upToNextMajorVersion',
+      minimumVersion: '8.0.0',
+    },
+  };
+  xcObjects.XCRemoteSwiftPackageReference[sentrySwiftPackageUUID + '_comment'] =
+    'XCRemoteSwiftPackageReference "sentry-cocoa"';
+
+  xcObjects.XCSwiftPackageProductDependency = {};
+  xcObjects.XCSwiftPackageProductDependency[sentrySPMUUID] = {
+    isa: 'XCSwiftPackageProductDependency',
+    package: sentrySwiftPackageUUID,
+    package_comment: 'XCRemoteSwiftPackageReference "sentry-cocoa"',
+    productName: 'Sentry',
+  };
+  xcObjects.XCSwiftPackageProductDependency[sentrySPMUUID + '_comment'] =
+    'Sentry';
 }
 
-function addUploadSymbolsScript(xcodeProject: any, sentryProject: SentryProjectData, apiKeys: { token: string }, uploadSource = true): void {
-    const xcObjects = xcodeProject.hash.project.objects;
-
-    for (const scriptKey in xcObjects.PBXShellScriptBuildPhase || {}) {
-        if (!scriptKey.endsWith("_comment")) {
-            const script = xcObjects.PBXShellScriptBuildPhase[scriptKey].shellScript;
-            //Sentry script already exists, update it
-            if (script.includes("sentry-cli")) {
-                delete xcObjects.PBXShellScriptBuildPhase[scriptKey];
-                delete xcObjects.PBXShellScriptBuildPhase[scriptKey + "_comment"];
-                break;
-            }
-        }
+function addUploadSymbolsScript(
+  xcodeProject: any,
+  sentryProject: SentryProjectData,
+  apiKeys: { token: string },
+  uploadSource = true,
+): void {
+  const xcObjects = xcodeProject.hash.project.objects;
+
+  for (const scriptKey in xcObjects.PBXShellScriptBuildPhase || {}) {
+    if (!scriptKey.endsWith('_comment')) {
+      const script = xcObjects.PBXShellScriptBuildPhase[scriptKey].shellScript;
+      //Sentry script already exists, update it
+      if (script.includes('sentry-cli')) {
+        delete xcObjects.PBXShellScriptBuildPhase[scriptKey];
+        delete xcObjects.PBXShellScriptBuildPhase[scriptKey + '_comment'];
+        break;
+      }
     }
+  }
 
-    xcodeProject.addBuildPhase(
-        [],
-        'PBXShellScriptBuildPhase',
-        'Upload Debug Symbols to Sentry',
-        null,
-        {
-            inputFileListPaths: [],
-            outputFileListPaths: [],
-            inputPaths: [templates.scriptInputPath],
-            shellPath: '/bin/sh',
-            shellScript: templates.getRunScriptTemplate(sentryProject.organization.slug, sentryProject.slug, apiKeys.token, uploadSource)
-        },
-    );
+  xcodeProject.addBuildPhase(
+    [],
+    'PBXShellScriptBuildPhase',
+    'Upload Debug Symbols to Sentry',
+    null,
+    {
+      inputFileListPaths: [],
+      outputFileListPaths: [],
+      inputPaths: [templates.scriptInputPath],
+      shellPath: '/bin/sh',
+      shellScript: templates.getRunScriptTemplate(
+        sentryProject.organization.slug,
+        sentryProject.slug,
+        apiKeys.token,
+        uploadSource,
+      ),
+    },
+  );
 }
 
-export function updateXcodeProject(projectPath: string, sentryProject: SentryProjectData, apiKeys: { token: string }, addSPMReference: boolean, uploadSource = true): void {
-    const proj = xcode.project(projectPath);
-    proj.parseSync();
-    addUploadSymbolsScript(proj, sentryProject, apiKeys, uploadSource);
-    if (uploadSource) {
-        setDebugInformationFormat(proj);
-    }
-    if (addSPMReference) {
-        addSentrySPM(proj);
-    }
-    const newContent = proj.writeSync();
-    fs.writeFileSync(projectPath, newContent);
-}
+export function updateXcodeProject(
+  projectPath: string,
+  sentryProject: SentryProjectData,
+  apiKeys: { token: string },
+  addSPMReference: boolean,
+  uploadSource = true,
+): void {
+  const proj = xcode.project(projectPath);
+  proj.parseSync();
+  addUploadSymbolsScript(proj, sentryProject, apiKeys, uploadSource);
+  if (uploadSource) {
+    setDebugInformationFormat(proj);
+  }
+  if (addSPMReference) {
+    addSentrySPM(proj);
+  }
+  const newContent = proj.writeSync();
+  fs.writeFileSync(projectPath, newContent);
+}

package/src/nextjs/nextjs-wizard.ts

@@ -11,11 +11,9 @@ import {
   abort,
   abortIfCancelled,
   addSentryCliRc,
-  askForProjectSelection,
-  askForSelfHosted,
-  askForWizardLogin,
   confirmContinueEvenThoughNoGitRepo,
   ensurePackageIsInstalled,
+  getOrAskForProjectData,
   getPackageDotJson,
   installPackage,
   isUsingTypeScript,
@@ -45,15 +43,8 @@ export async function runNextjsWizard(options: WizardOptions): Promise<void> {
   const packageJson = await getPackageDotJson();
   await ensurePackageIsInstalled(packageJson, 'next', 'Next.js');
 
-  const { url: sentryUrl, selfHosted } = await askForSelfHosted(options.url);
-
-  const { projects, apiKeys } = await askForWizardLogin({
-    promoCode: options.promoCode,
-    url: sentryUrl,
-    platform: 'javascript-nextjs',
-  });
-
-  const selectedProject = await askForProjectSelection(projects);
+  const { selectedProject, authToken, selfHosted, sentryUrl } =
+    await getOrAskForProjectData(options);
 
   await installPackage({
     packageName: '@sentry/nextjs',
@@ -349,7 +340,7 @@ export async function runNextjsWizard(options: WizardOptions): Promise<void> {
     );
   }
 
-  await addSentryCliRc(apiKeys.token);
+  await addSentryCliRc(authToken);
 
   const mightBeUsingVercel = fs.existsSync(
     path.join(process.cwd(), 'vercel.json'),

package/src/sourcemaps/sourcemaps-wizard.ts

@@ -5,14 +5,12 @@ import * as Sentry from '@sentry/node';
 
 import {
   abortIfCancelled,
-  askForProjectSelection,
-  askForSelfHosted,
-  askForWizardLogin,
   confirmContinueEvenThoughNoGitRepo,
   detectPackageManager,
   SENTRY_DOT_ENV_FILE,
   printWelcome,
   SENTRY_CLI_RC_FILE,
+  getOrAskForProjectData,
 } from '../utils/clack-utils';
 import { isUnicodeSupported } from '../utils/vendor/is-unicorn-supported';
 import { SourceMapUploadToolConfigurationOptions } from './tools/types';
@@ -30,6 +28,7 @@ import { URL } from 'url';
 import { checkIfMoreSuitableWizardExistsAndAskForRedirect } from './utils/other-wizards';
 import { configureAngularSourcemapGenerationFlow } from './tools/angular';
 import { detectUsedTool, SupportedTools } from './utils/detect-tool';
+import { configureNextJsSourceMapsUpload } from './tools/nextjs';
 
 export async function runSourcemapsWizard(
   options: WizardOptions,
@@ -48,8 +47,15 @@ async function runSourcemapsWizardWithTelemetry(
 ): Promise<void> {
   printWelcome({
     wizardName: 'Sentry Source Maps Upload Configuration Wizard',
-    message:
-      'This wizard will help you upload source maps to Sentry as part of your build.\nThank you for using Sentry :)\n\n(This setup wizard sends telemetry data and crash reports to Sentry.\nYou can turn this off by running the wizard with the `--disable-telemetry` flag.)',
+    message: `This wizard will help you upload source maps to Sentry as part of your build.
+Thank you for using Sentry :)${
+      options.telemetryEnabled
+        ? `
+
+(This setup wizard sends telemetry data and crash reports to Sentry.
+You can turn this off by running the wizard with the '--disable-telemetry' flag.)`
+        : ''
+    }`,
     promoCode: options.promoCode,
   });
 
@@ -66,37 +72,37 @@ async function runSourcemapsWizardWithTelemetry(
 
   await traceStep('check-sdk-version', ensureMinimumSdkVersionIsInstalled);
 
-  const { url: sentryUrl, selfHosted } = await traceStep(
-    'ask-self-hosted',
-    () => askForSelfHosted(options.url),
-  );
-
-  const { projects, apiKeys } = await traceStep('login', () =>
-    askForWizardLogin({
-      promoCode: options.promoCode,
-      url: sentryUrl,
-    }),
-  );
+  const { selfHosted, selectedProject, sentryUrl, authToken } =
+    await getOrAskForProjectData(options);
 
-  const selectedProject = await traceStep('select-project', () =>
-    askForProjectSelection(projects),
-  );
+  const wizardOptionsWithPreSelectedProject = {
+    ...options,
+    preSelectedProject: {
+      project: selectedProject,
+      authToken,
+      selfHosted,
+    },
+  };
 
   const selectedTool = await traceStep('select-tool', askForUsedBundlerTool);
 
   Sentry.setTag('selected-tool', selectedTool);
 
   await traceStep('tool-setup', () =>
-    startToolSetupFlow(selectedTool, {
-      selfHosted,
-      orgSlug: selectedProject.organization.slug,
-      projectSlug: selectedProject.slug,
-      url: sentryUrl,
-      authToken: apiKeys.token,
-    }),
+    startToolSetupFlow(
+      selectedTool,
+      {
+        orgSlug: selectedProject.organization.slug,
+        projectSlug: selectedProject.slug,
+        selfHosted,
+        url: sentryUrl,
+        authToken,
+      },
+      wizardOptionsWithPreSelectedProject,
+    ),
   );
 
-  await traceStep('ci-setup', () => configureCI(selectedTool, apiKeys.token));
+  await traceStep('ci-setup', () => configureCI(selectedTool, authToken));
 
   traceStep('outro', () =>
     printOutro(
@@ -122,6 +128,11 @@ async function askForUsedBundlerTool(): Promise<SupportedTools> {
           value: 'create-react-app',
           hint: 'Select this option if you set up your app with Create React App.',
         },
+        {
+          label: 'Next.js',
+          value: 'nextjs',
+          hint: 'Select this option if you want to set up source maps in a NextJS project.',
+        },
         {
           label: 'Webpack',
           value: 'webpack',
@@ -163,6 +174,7 @@ async function askForUsedBundlerTool(): Promise<SupportedTools> {
 async function startToolSetupFlow(
   selctedTool: SupportedTools,
   options: SourceMapUploadToolConfigurationOptions,
+  wizardOptions: WizardOptions,
 ): Promise<void> {
   switch (selctedTool) {
     case 'webpack':
@@ -189,6 +201,9 @@ async function startToolSetupFlow(
         configureAngularSourcemapGenerationFlow,
       );
       break;
+    case 'nextjs':
+      await configureNextJsSourceMapsUpload(options, wizardOptions);
+      break;
     default:
       await configureSentryCLI(options);
       break;
@@ -227,9 +242,13 @@ async function configureCI(
     'create-react-app',
   ].includes(selectedTool);
 
-  const authTokenFile = isCliBasedFlowTool
-    ? SENTRY_CLI_RC_FILE
-    : SENTRY_DOT_ENV_FILE;
+  // some non-cli-based flows also use the .sentryclirc file
+  const usesSentryCliRc = selectedTool === 'nextjs';
+
+  const authTokenFile =
+    isCliBasedFlowTool || usesSentryCliRc
+      ? SENTRY_CLI_RC_FILE
+      : SENTRY_DOT_ENV_FILE;
 
   if (!isUsingCI) {
     clack.log.info(

package/src/sourcemaps/tools/nextjs.ts

@@ -0,0 +1,114 @@
+// @ts-ignore - clack is ESM and TS complains about that. It works though
+import * as clack from '@clack/prompts';
+import chalk from 'chalk';
+import { runNextjsWizard } from '../../nextjs/nextjs-wizard';
+import { traceStep } from '../../telemetry';
+import { abortIfCancelled, addSentryCliRc } from '../../utils/clack-utils';
+import { WizardOptions } from '../../utils/types';
+
+import { SourceMapUploadToolConfigurationOptions } from './types';
+
+import * as Sentry from '@sentry/node';
+
+const getCodeSnippet = (options: SourceMapUploadToolConfigurationOptions) =>
+  chalk.grey(`
+  ${chalk.greenBright(
+    'const { withSentryConfig } = require("@sentry/nextjs");',
+  )}
+
+  const nextConfig = {
+    // your existing next config
+  };
+  
+  ${chalk.greenBright(`const sentryWebpackPluginOptions = {
+    org: "${options.orgSlug}",
+    project: "${options.projectSlug}",${
+    options.selfHosted ? `\n    url: "${options.url}",` : ''
+  }
+  };`)}
+  
+  ${chalk.greenBright(`const sentryOptions = {
+    // Upload additional client files (increases upload size)
+    widenClientFileUpload: true,
+
+    // Hides source maps from generated client bundles
+    hideSourceMaps: true,
+  };`)}
+  
+  ${chalk.greenBright(`module.exports = withSentryConfig(
+    nextConfig,
+    sentryWebpackPluginOptions,
+    sentryOptions
+  );`)}  
+`);
+
+export const configureNextJsSourceMapsUpload = async (
+  options: SourceMapUploadToolConfigurationOptions,
+  wizardOptions: WizardOptions,
+) => {
+  clack.log
+    .info(`Source Maps upload for Next.js is configured automatically by default if you run the Sentry Wizard for Next.JS.
+But don't worry, we can redirect you to the wizard now!
+
+In case you already tried the wizard, we can also show you how to configure your ${chalk.cyan(
+    'next.config.js',
+  )} file manually instead.`);
+
+  const shouldRedirect: boolean = await abortIfCancelled(
+    clack.select({
+      message: 'Do you want to run the Sentry Wizard for Next.JS now?',
+      options: [
+        {
+          label: 'Yes, run the wizard!',
+          value: true,
+          hint: 'The wizard can also configure your SDK setup',
+        },
+        {
+          label: 'No, show me how to configure it manually',
+          value: false,
+        },
+      ],
+    }),
+  );
+
+  Sentry.setTag('redirect-nextjs-wizard', shouldRedirect);
+
+  if (shouldRedirect) {
+    await traceStep('run-nextjs-wizard', () => runNextjsWizard(wizardOptions));
+    clack.intro('Sentry Source Maps Upload Configuration Wizard');
+    clack.log.info(
+      "Welcome back to the Source Maps wizard - we're almost done ;)",
+    );
+  } else {
+    clack.log.info(
+      `Add the following code to your ${chalk.cyan('next.config.js')}:`,
+    );
+
+    // Intentionally logging directly to console here
+    // eslint-disable-next-line no-console
+    console.log(getCodeSnippet(options));
+
+    await traceStep('nextjs-manual-nextconfigjs', () =>
+      abortIfCancelled(
+        clack.select({
+          message: 'Did you copy the code above?',
+          options: [{ label: 'Yes, continue!', value: true }],
+          initialValue: true,
+        }),
+      ),
+    );
+
+    await traceStep('nextjs-manual-sentryclirc', () =>
+      addSentryCliRc(options.authToken),
+    );
+  }
+
+  clack.log
+    .info(`In case you still run into problems, check out our docs to further debug your setup:
+
+Uploading Source Maps:
+https://docs.sentry.io/platforms/javascript/guides/nextjs/manual-setup/#configure-source-maps
+  
+Troubleshooting Source Maps:
+https://docs.sentry.io/platforms/javascript/guides/nextjs/troubleshooting/`);
+};