@sentry/wizard 3.14.1 → 3.16.0

package/src/sourcemaps/tools/nextjs.ts

@@ -19,14 +19,14 @@ const getCodeSnippet = (options: SourceMapUploadToolConfigurationOptions) =>
   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,
@@ -34,12 +34,12 @@ const getCodeSnippet = (options: SourceMapUploadToolConfigurationOptions) =>
     // Hides source maps from generated client bundles
     hideSourceMaps: true,
   };`)}
-  
+
   ${chalk.greenBright(`module.exports = withSentryConfig(
     nextConfig,
     sentryWebpackPluginOptions,
     sentryOptions
-  );`)}  
+  );`)}
 `);
 
 export const configureNextJsSourceMapsUpload = async (
@@ -99,7 +99,7 @@ In case you already tried the wizard, we can also show you how to configure your
     );
 
     await traceStep('nextjs-manual-sentryclirc', () =>
-      addSentryCliConfig(options.authToken),
+      addSentryCliConfig({ authToken: options.authToken }),
     );
   }
 
@@ -108,7 +108,7 @@ In case you already tried the wizard, we can also show you how to configure your
 
 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/`);
 };

package/src/sourcemaps/tools/sentry-cli.ts

@@ -96,7 +96,7 @@ export async function configureSentryCLI(
     );
   }
 
-  await addSentryCliConfig(options.authToken);
+  await addSentryCliConfig({ authToken: options.authToken });
 }
 
 export async function setupNpmScriptInCI(): Promise<void> {

package/src/sveltekit/sveltekit-wizard.ts

@@ -95,7 +95,7 @@ export async function runSvelteKitWizardWithTelemetry(
     alreadyInstalled: sdkAlreadyInstalled,
   });
 
-  await addSentryCliConfig(authToken);
+  await addSentryCliConfig({ authToken });
 
   const svelteConfig = await traceStep('load-svelte-config', loadSvelteConfig);
 

package/src/utils/clack-utils.ts

@@ -19,6 +19,7 @@ import {
   packageManagers,
 } from './package-manager';
 import { debug } from './debug';
+import { fulfillsVersionRange } from './semver';
 
 const opn = require('opn') as (
   url: string,
@@ -40,17 +41,29 @@ interface WizardProjectData {
 export interface CliSetupConfig {
   filename: string;
   name: string;
+  gitignore: boolean;
 
   likelyAlreadyHasAuthToken(contents: string): boolean;
   tokenContent(authToken: string): string;
 
   likelyAlreadyHasOrgAndProject(contents: string): boolean;
   orgAndProjContent(org: string, project: string): string;
+
+  likelyAlreadyHasUrl?(contents: string): boolean;
+  urlContent?(url: string): string;
+}
+
+export interface CliSetupConfigContent {
+  authToken: string;
+  org?: string;
+  project?: string;
+  url?: string;
 }
 
-export const sourceMapsCliSetupConfig: CliSetupConfig = {
+export const rcCliSetupConfig: CliSetupConfig = {
   filename: SENTRY_CLI_RC_FILE,
   name: 'source maps',
+  gitignore: true,
   likelyAlreadyHasAuthToken: function (contents: string): boolean {
     return !!(contents.includes('[auth]') && contents.match(/token=./g));
   },
@@ -69,6 +82,33 @@ export const sourceMapsCliSetupConfig: CliSetupConfig = {
   },
 };
 
+export const propertiesCliSetupConfig: Required<CliSetupConfig> = {
+  filename: SENTRY_PROPERTIES_FILE,
+  gitignore: true,
+  name: 'debug files',
+  likelyAlreadyHasAuthToken(contents: string): boolean {
+    return !!contents.match(/auth\.token=./g);
+  },
+  tokenContent(authToken: string): string {
+    return `auth.token=${authToken}`;
+  },
+  likelyAlreadyHasOrgAndProject(contents: string): boolean {
+    return !!(
+      contents.match(/defaults\.org=./g) &&
+      contents.match(/defaults\.project=./g)
+    );
+  },
+  orgAndProjContent(org: string, project: string): string {
+    return `defaults.org=${org}\ndefaults.project=${project}`;
+  },
+  likelyAlreadyHasUrl(contents: string): boolean {
+    return !!contents.match(/defaults\.url=./g);
+  },
+  urlContent(url: string): string {
+    return `defaults.url=${url}`;
+  },
+};
+
 export async function abort(message?: string, status?: number): Promise<never> {
   clack.outro(message ?? 'Wizard setup cancelled.');
   const sentryHub = Sentry.getCurrentHub();
@@ -248,6 +288,58 @@ export async function askForItemSelection(
   return selection;
 }
 
+export async function confirmContinueIfPackageVersionNotSupported({
+  packageId,
+  packageName,
+  packageVersion,
+  acceptableVersions,
+}: {
+  packageId: string;
+  packageName: string;
+  packageVersion: string;
+  acceptableVersions: string;
+}): Promise<void> {
+  return traceStep(`check-package-version`, async () => {
+    Sentry.setTag(`${packageName.toLowerCase()}-version`, packageVersion);
+    const isSupportedVersion = fulfillsVersionRange({
+      acceptableVersions,
+      version: packageVersion,
+      canBeLatest: true,
+    });
+
+    if (isSupportedVersion) {
+      Sentry.setTag(`${packageName.toLowerCase()}-supported`, true);
+      return;
+    }
+
+    clack.log.warn(
+      `You have an unsupported version of ${packageName} installed:
+
+  ${packageId}@${packageVersion}`,
+    );
+
+    clack.note(
+      `Please upgrade to ${acceptableVersions} if you wish to use the Sentry Wizard.
+Or setup using ${chalk.cyan(
+        'https://docs.sentry.io/platforms/react-native/manual-setup/manual-setup/',
+      )}`,
+    );
+    const continueWithUnsupportedVersion = await abortIfCancelled(
+      clack.confirm({
+        message: 'Do you want to continue anyway?',
+      }),
+    );
+    Sentry.setTag(
+      `${packageName.toLowerCase()}-continue-with-unsupported-version`,
+      continueWithUnsupportedVersion,
+    );
+
+    if (!continueWithUnsupportedVersion) {
+      await abort(undefined, 0);
+    }
+  });
+}
+
 export async function installPackage({
   packageName,
   alreadyInstalled,
@@ -306,80 +398,143 @@ export async function installPackage({
 }
 
 export async function addSentryCliConfig(
-  authToken: string,
-  setupConfig: CliSetupConfig = sourceMapsCliSetupConfig,
+  { authToken, org, project, url }: CliSetupConfigContent,
+  setupConfig: CliSetupConfig = rcCliSetupConfig,
 ): Promise<void> {
   return traceStep('add-sentry-cli-config', async () => {
-    const configExists = fs.existsSync(
-      path.join(process.cwd(), setupConfig.filename),
+    const configPath = path.join(process.cwd(), setupConfig.filename);
+    const configExists = fs.existsSync(configPath);
+
+    let configContents =
+      (configExists && fs.readFileSync(configPath, 'utf8')) || '';
+    configContents = addAuthTokenToSentryConfig(
+      configContents,
+      authToken,
+      setupConfig,
     );
-    if (configExists) {
-      const configContents = fs.readFileSync(
-        path.join(process.cwd(), setupConfig.filename),
-        'utf8',
+    configContents = addOrgAndProjectToSentryConfig(
+      configContents,
+      org,
+      project,
+      setupConfig,
+    );
+    configContents = addUrlToSentryConfig(configContents, url, setupConfig);
+
+    try {
+      await fs.promises.writeFile(configPath, configContents, {
+        encoding: 'utf8',
+        flag: 'w',
+      });
+      clack.log.success(
+        `${configExists ? 'Saved' : 'Created'} ${chalk.cyan(
+          setupConfig.filename,
+        )}.`,
       );
+    } catch {
+      clack.log.warning(
+        `Failed to add auth token to ${chalk.cyan(
+          setupConfig.filename,
+        )}. Uploading ${
+          setupConfig.name
+        } during build will likely not work locally.`,
+      );
+    }
 
-      if (setupConfig.likelyAlreadyHasAuthToken(configContents)) {
-        clack.log.warn(
-          `${chalk.bold(
-            setupConfig.filename,
-          )} already has auth token. Will not add one.`,
-        );
-      } else {
-        try {
-          await fs.promises.writeFile(
-            path.join(process.cwd(), setupConfig.filename),
-            `${configContents}\n${setupConfig.tokenContent(authToken)}\n`,
-            { encoding: 'utf8', flag: 'w' },
-          );
-          clack.log.success(
-            chalk.greenBright(
-              `Added auth token to ${chalk.bold(
-                setupConfig.filename,
-              )} for you to test uploading ${setupConfig.name} locally.`,
-            ),
-          );
-        } catch {
-          clack.log.warning(
-            `Failed to add auth token to ${chalk.bold(
-              setupConfig.filename,
-            )}. Uploading ${
-              setupConfig.name
-            } during build will likely not work locally.`,
-          );
-        }
-      }
+    if (setupConfig.gitignore) {
+      await addCliConfigFileToGitIgnore(setupConfig.filename);
     } else {
-      try {
-        await fs.promises.writeFile(
-          path.join(process.cwd(), setupConfig.filename),
-          `${setupConfig.tokenContent(authToken)}\n`,
-          { encoding: 'utf8', flag: 'w' },
-        );
-        clack.log.success(
-          chalk.greenBright(
-            `Created ${chalk.bold(
-              setupConfig.filename,
-            )} with auth token for you to test uploading ${
-              setupConfig.name
-            } locally.`,
-          ),
-        );
-      } catch {
-        clack.log.warning(
-          `Failed to create ${chalk.bold(
-            setupConfig.filename,
-          )} with auth token. Uploading ${
-            setupConfig.name
-          } during build will likely not work locally.`,
-        );
-      }
+      clack.log.warn(
+        chalk.yellow('DO NOT commit auth token to your repository!'),
+      );
     }
-
-    await addAuthTokenFileToGitIgnore(setupConfig.filename);
   });
 }
 
+function addAuthTokenToSentryConfig(
+  configContents: string,
+  authToken: string | undefined,
+  setupConfig: CliSetupConfig,
+): string {
+  if (!authToken) {
+    return configContents;
+  }
+
+  if (setupConfig.likelyAlreadyHasAuthToken(configContents)) {
+    clack.log.warn(
+      `${chalk.cyan(
+        setupConfig.filename,
+      )} already has auth token. Will not add one.`,
+    );
+    return configContents;
+  }
+
+  const newContents = `${configContents}\n${setupConfig.tokenContent(
+    authToken,
+  )}\n`;
+  clack.log.success(
+    `Added auth token to ${chalk.cyan(
+      setupConfig.filename,
+    )} for you to test uploading ${setupConfig.name} locally.`,
+  );
+  return newContents;
+}
+
+function addOrgAndProjectToSentryConfig(
+  configContents: string,
+  org: string | undefined,
+  project: string | undefined,
+  setupConfig: CliSetupConfig,
+): string {
+  if (!org || !project) {
+    return configContents;
+  }
+
+  if (setupConfig.likelyAlreadyHasOrgAndProject(configContents)) {
+    clack.log.warn(
+      `${chalk.cyan(
+        setupConfig.filename,
+      )} already has org and project. Will not add them.`,
+    );
+    return configContents;
+  }
+
+  const newContents = `${configContents}\n${setupConfig.orgAndProjContent(
+    org,
+    project,
+  )}\n`;
+  clack.log.success(
+    `Added default org and project to ${chalk.cyan(
+      setupConfig.filename,
+    )} for you to test uploading ${setupConfig.name} locally.`,
+  );
+  return newContents;
+}
+
+function addUrlToSentryConfig(
+  configContents: string,
+  url: string | undefined,
+  setupConfig: CliSetupConfig,
+): string {
+  if (!url || !setupConfig.urlContent || !setupConfig.likelyAlreadyHasUrl) {
+    return configContents;
+  }
+
+  if (setupConfig.likelyAlreadyHasUrl(configContents)) {
+    clack.log.warn(
+      `${chalk.cyan(setupConfig.filename)} already has url. Will not add one.`,
+    );
+    return configContents;
+  }
+
+  const newContents = `${configContents}\n${setupConfig.urlContent(url)}\n`;
+  clack.log.success(
+    `Added default url to ${chalk.cyan(
+      setupConfig.filename,
+    )} for you to test uploading ${setupConfig.name} locally.`,
+  );
+  return newContents;
+}
+
 export async function addDotEnvSentryBuildPluginFile(
   authToken: string,
 ): Promise<void> {
@@ -447,25 +602,23 @@ SENTRY_AUTH_TOKEN="${authToken}"
     }
   }
 
-  await addAuthTokenFileToGitIgnore(SENTRY_DOT_ENV_FILE);
+  await addCliConfigFileToGitIgnore(SENTRY_DOT_ENV_FILE);
 }
 
-async function addAuthTokenFileToGitIgnore(filename: string): Promise<void> {
+async function addCliConfigFileToGitIgnore(filename: string): Promise<void> {
   //TODO: Add a check to see if the file is already ignored in .gitignore
   try {
     await fs.promises.appendFile(
       path.join(process.cwd(), '.gitignore'),
-      `\n# Sentry Auth Token\n${filename}\n`,
+      `\n# Sentry Config File\n${filename}\n`,
       { encoding: 'utf8' },
     );
     clack.log.success(
-      chalk.greenBright(
-        `Added ${chalk.bold(filename)} to ${chalk.bold('.gitignore')}.`,
-      ),
+      `Added ${chalk.cyan(filename)} to ${chalk.cyan('.gitignore')}.`,
     );
   } catch {
     clack.log.error(
-      `Failed adding ${chalk.bold(filename)} to ${chalk.bold(
+      `Failed adding ${chalk.cyan(filename)} to ${chalk.cyan(
         '.gitignore',
       )}. Please add it manually!`,
     );
@@ -585,7 +738,8 @@ export async function getOrAskForProjectData(
     | 'javascript-remix'
     | 'javascript-sveltekit'
     | 'apple-ios'
-    | 'android',
+    | 'android'
+    | 'react-native',
 ): Promise<{
   sentryUrl: string;
   selfHosted: boolean;
@@ -713,7 +867,8 @@ async function askForWizardLogin(options: {
     | 'javascript-remix'
     | 'javascript-sveltekit'
     | 'apple-ios'
-    | 'android';
+    | 'android'
+    | 'react-native';
 }): Promise<WizardProjectData> {
   Sentry.setTag('has-promo-code', !!options.promoCode);
 

package/src/utils/semver.ts

@@ -0,0 +1,33 @@
+import { satisfies, subset, valid, validRange } from 'semver';
+
+export function fulfillsVersionRange({
+  version,
+  acceptableVersions,
+  canBeLatest,
+}: {
+  version: string;
+  acceptableVersions: string;
+  canBeLatest: boolean;
+}): boolean {
+  if (version === 'latest') {
+    return canBeLatest;
+  }
+
+  let cleanedUserVersion, isRange;
+
+  if (valid(version)) {
+    cleanedUserVersion = valid(version);
+    isRange = false;
+  } else if (validRange(version)) {
+    cleanedUserVersion = validRange(version);
+    isRange = true;
+  }
+
+  return (
+    // If the given version is a bogus format, this will still be undefined and we'll automatically reject it
+    !!cleanedUserVersion &&
+    (isRange
+      ? subset(cleanedUserVersion, acceptableVersions)
+      : satisfies(cleanedUserVersion, acceptableVersions))
+  );
+}

package/src/utils/sentrycli-utils.ts

@@ -13,7 +13,9 @@ export function createSentryCLIRC(
   const rcPath = path.join(directory, '.sentryclirc');
   fs.writeFileSync(rcPath, '[auth]\ntoken=' + params.auth_token);
 
-  if (fs.existsSync('.gitignore')) {
+  if (!fs.existsSync('.gitignore')) {
+    fs.writeFileSync('.gitignore', '.sentryclirc');
+  } else {
     const gitIgnore = fs.readFileSync('.gitignore').toString();
     if (!gitIgnore.includes('.sentryclirc')) {
       fs.appendFileSync('.gitignore', '\n.sentryclirc');

package/src/utils/types.ts

@@ -5,6 +5,9 @@ export interface SentryProjectData {
   platform: string;
   organization: {
     slug: string;
+    links: {
+      organizationUrl: string;
+    };
   };
   keys: [{ dsn: { public: string } }];
 }