@sentry/wizard 3.9.2 → 3.10.0

package/src/sourcemaps/tools/remix.ts

@@ -0,0 +1,90 @@
+// @ts-ignore - clack is ESM and TS complains about that. It works though
+import * as clack from '@clack/prompts';
+import chalk from 'chalk';
+import { runRemixWizard } from '../../remix/remix-wizard';
+import { traceStep } from '../../telemetry';
+import { abortIfCancelled } from '../../utils/clack-utils';
+import { WizardOptions } from '../../utils/types';
+import { SourceMapUploadToolConfigurationOptions } from './types';
+
+import * as Sentry from '@sentry/node';
+
+export const configureRemixSourceMapsUpload = async (
+  options: SourceMapUploadToolConfigurationOptions,
+  wizardOptions: WizardOptions,
+) => {
+  clack.log
+    .info(`Source Maps upload for Remix is configured automatically by default if you run the Sentry Wizard for Remix.
+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(
+    'remix.config.js',
+  )} file manually instead.`);
+
+  const shouldRedirect: boolean = await abortIfCancelled(
+    clack.select({
+      message: 'Do you want to run the Sentry Wizard for Remix 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-remix-wizard', shouldRedirect);
+
+  if (shouldRedirect) {
+    await traceStep('run-remix-wizard', () => runRemixWizard(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.step(
+      `Build your app with ${chalk.cyan(
+        'remix build --sourcemap',
+      )}, then upload your source maps using ${chalk.cyan(
+        'sentry-upload-sourcemaps',
+      )} cli tool.`,
+    );
+
+    clack.log.step(
+      `You can add ${chalk.cyan(
+        'sentry-upload-sourcemaps',
+      )} to your build script in ${chalk.cyan('package.json')} like this:`,
+    );
+
+    // Intentially logging directly to console here so that the code can be copied/pasted directly
+    // eslint-disable-next-line no-console
+    console.log(codeSnippet);
+
+    clack.log.step(`or run it manually after building your app.
+
+To see all available options for ${chalk.cyan(
+      'sentry-upload-sourcemaps',
+    )}, run ${chalk.cyan('sentry-upload-sourcemaps --help')}
+`);
+
+    await abortIfCancelled(
+      clack.select({
+        message: 'Did you finish configuring your build and prod scripts?',
+        options: [{ label: 'Yes, continue!', value: true }],
+        initialValue: true,
+      }),
+    );
+  }
+};
+
+const codeSnippet = chalk.gray(`
+"scripts": {
+  ${chalk.greenBright(
+    '"build": "remix build --sourcemap && sentry-upload-sourcemaps"',
+  )};
+}
+`);

package/src/sourcemaps/utils/detect-tool.ts

@@ -10,7 +10,8 @@ export type SupportedTools =
   | 'sentry-cli'
   | 'create-react-app'
   | 'angular'
-  | 'nextjs';
+  | 'nextjs'
+  | 'remix';
 
 // A map of package names pointing to the tool slug.
 // The order is important, because we want to detect the most specific tool first.
@@ -25,6 +26,7 @@ export const TOOL_PACKAGE_MAP: Record<string, SupportedTools> = {
   esbuild: 'esbuild',
   rollup: 'rollup',
   typescript: 'tsc',
+  remix: 'remix',
 };
 
 export async function detectUsedTool(): Promise<SupportedTools> {

package/src/utils/clack-utils.ts

@@ -66,6 +66,7 @@ export function printWelcome(options: {
   wizardName: string;
   promoCode?: string;
   message?: string;
+  telemetryEnabled?: boolean;
 }): void {
   let wizardPackage: { version?: string } = {};
 
@@ -96,6 +97,10 @@ export function printWelcome(options: {
     welcomeText += `\n\nVersion: ${wizardPackage.version}`;
   }
 
+  if (options.telemetryEnabled) {
+    welcomeText += `\n\nYou are using the Sentry Wizard with telemetry enabled. This helps us improve the Wizard.\nYou can disable it at any time by running \`sentry-wizard --disable-telemetry\`.`;
+  }
+
   clack.note(welcomeText);
 }
 
@@ -132,7 +137,11 @@ export async function askToInstallSentryCLI(): Promise<boolean> {
 export async function askForWizardLogin(options: {
   url: string;
   promoCode?: string;
-  platform?: 'javascript-nextjs' | 'javascript-sveltekit' | 'apple-ios';
+  platform?:
+    | 'javascript-nextjs'
+    | 'javascript-remix'
+    | 'javascript-sveltekit'
+    | 'apple-ios';
 }): Promise<WizardProjectData> {
   Sentry.setTag('has-promo-code', !!options.promoCode);
 
@@ -408,7 +417,48 @@ export async function askForSelfHosted(urlFromArgs?: string): Promise<{
   return { url: validUrl, selfHosted: true };
 }
 
-export async function addSentryCliRc(authToken: string): Promise<void> {
+async function addOrgAndProjectToSentryCliRc(
+  org: string,
+  project: string,
+): Promise<void> {
+  const clircContents = fs.readFileSync(
+    path.join(process.cwd(), SENTRY_CLI_RC_FILE),
+    'utf8',
+  );
+
+  const likelyAlreadyHasOrgAndProject = !!(
+    clircContents.includes('[defaults]') &&
+    clircContents.match(/org=./g) &&
+    clircContents.match(/project=./g)
+  );
+
+  if (likelyAlreadyHasOrgAndProject) {
+    clack.log.warn(
+      `${chalk.bold(
+        SENTRY_CLI_RC_FILE,
+      )} already has org and project. Will not add them.`,
+    );
+  } else {
+    try {
+      await fs.promises.appendFile(
+        path.join(process.cwd(), SENTRY_CLI_RC_FILE),
+        `\n[defaults]\norg=${org}\nproject=${project}\n`,
+      );
+    } catch (e) {
+      clack.log.warn(
+        `${chalk.bold(
+          SENTRY_CLI_RC_FILE,
+        )} could not be updated with org and project.`,
+      );
+    }
+  }
+}
+
+export async function addSentryCliRc(
+  authToken: string,
+  orgSlug?: string,
+  projectSlug?: string,
+): Promise<void> {
   const clircExists = fs.existsSync(
     path.join(process.cwd(), SENTRY_CLI_RC_FILE),
   );
@@ -469,6 +519,10 @@ export async function addSentryCliRc(authToken: string): Promise<void> {
     }
   }
 
+  if (orgSlug && projectSlug) {
+    await addOrgAndProjectToSentryCliRc(orgSlug, projectSlug);
+  }
+
   await addAuthTokenFileToGitIgnore(SENTRY_CLI_RC_FILE);
 }