@sentry/wizard 3.38.0 → 3.39.0

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

@@ -61,24 +61,27 @@ app.all(
 app.listen(0, () => console.log('Express server listening'));
 `;
 
-
-async function runWizardOnRemixProject(projectDir: string, integration: Integration, fileModificationFn?: (projectDir: string, integration: Integration) => unknown) {
+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?',
-    );
+    await wizardInstance.waitForOutput('Do you want to continue anyway?');
 
     packageManagerPrompted = await wizardInstance.sendStdinAndWaitForOutput(
       [KEYS.ENTER],
       'Please select your package manager.',
     );
   } else {
-
     packageManagerPrompted = await wizardInstance.waitForOutput(
       'Please select your package manager.',
     );
@@ -119,12 +122,16 @@ async function runWizardOnRemixProject(projectDir: string, integration: Integrat
   );
 
   wizardInstance.kill();
-};
+}
 
-function checkRemixProject(projectDir: string, integration: Integration, options?: {
-  devModeExpectedOutput?: string;
-  prodModeExpectedOutput?: string;
-}) {
+function checkRemixProject(
+  projectDir: string,
+  integration: Integration,
+  options?: {
+    devModeExpectedOutput?: string;
+    prodModeExpectedOutput?: string;
+  },
+) {
   test('package.json is updated correctly', () => {
     checkPackageJson(projectDir, integration);
   });
@@ -195,15 +202,21 @@ function checkRemixProject(projectDir: string, integration: Integration, options
   });
 
   test('builds successfully', async () => {
-    await checkIfBuilds(projectDir, 'built');
+    await checkIfBuilds(projectDir);
   });
 
   test('runs on dev mode correctly', async () => {
-    await checkIfRunsOnDevMode(projectDir, options?.devModeExpectedOutput || 'to expose');
+    await checkIfRunsOnDevMode(
+      projectDir,
+      options?.devModeExpectedOutput || 'to expose',
+    );
   });
 
   test('runs on prod mode correctly', async () => {
-    await checkIfRunsOnProdMode(projectDir, options?.prodModeExpectedOutput || '[remix-serve]');
+    await checkIfRunsOnProdMode(
+      projectDir,
+      options?.prodModeExpectedOutput || '[remix-serve]',
+    );
   });
 }
 
@@ -236,13 +249,11 @@ describe('Remix', () => {
 
     beforeAll(async () => {
       await runWizardOnRemixProject(projectDir, integration, (projectDir) => {
-        createFile(
-          `${projectDir}/server.mjs`,
-          SERVER_TEMPLATE,
-        );
+        createFile(`${projectDir}/server.mjs`, SERVER_TEMPLATE);
 
         modifyFile(`${projectDir}/package.json`, {
-          '"start": "remix-serve ./build/server/index.js"': '"start": "node ./server.mjs"',
+          '"start": "remix-serve ./build/server/index.js"':
+            '"start": "node ./server.mjs"',
           '"dev": "remix vite:dev"': '"dev": "node ./server.mjs"',
         });
       });

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

@@ -41,7 +41,14 @@ export async function handleError({ error, event }) {
 }
 `;
 
-async function runWizardOnSvelteKitProject(projectDir: string, integration: Integration, fileModificationFn?: (projectDir: string, integration: Integration) => unknown) {
+async function runWizardOnSvelteKitProject(
+  projectDir: string,
+  integration: Integration,
+  fileModificationFn?: (
+    projectDir: string,
+    integration: Integration,
+  ) => unknown,
+) {
   const wizardInstance = startWizardInstance(integration, projectDir);
   let packageManagerPrompted = false;
 
@@ -49,9 +56,7 @@ async function runWizardOnSvelteKitProject(projectDir: string, integration: Inte
     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?',
-    );
+    await wizardInstance.waitForOutput('Do you want to continue anyway?');
 
     packageManagerPrompted = await wizardInstance.sendStdinAndWaitForOutput(
       [KEYS.ENTER],
@@ -59,7 +64,7 @@ async function runWizardOnSvelteKitProject(projectDir: string, integration: Inte
     );
   } else {
     packageManagerPrompted = await wizardInstance.waitForOutput(
-      'Please select your package manager'
+      'Please select your package manager',
     );
   }
 
@@ -72,7 +77,7 @@ async function runWizardOnSvelteKitProject(projectDir: string, integration: Inte
       'to track the performance of your application?',
       {
         timeout: 240_000,
-      }
+      },
     ));
 
   const replayOptionPrompted =
@@ -100,10 +105,14 @@ async function runWizardOnSvelteKitProject(projectDir: string, integration: Inte
   wizardInstance.kill();
 }
 
-function checkSvelteKitProject(projectDir: string, integration: Integration, options?: {
-  devModeExpectedOutput: string;
-  prodModeExpectedOutput: string;
-}) {
+function checkSvelteKitProject(
+  projectDir: string,
+  integration: Integration,
+  options?: {
+    devModeExpectedOutput: string;
+    prodModeExpectedOutput: string;
+  },
+) {
   test('should have the correct package.json', () => {
     checkPackageJson(projectDir, integration);
   });
@@ -113,14 +122,21 @@ function checkSvelteKitProject(projectDir: string, integration: Integration, opt
   });
 
   test('example page exists', () => {
-    checkFileExists(path.resolve(projectDir, 'src/routes/sentry-example/+page.svelte'));
-    checkFileExists(path.resolve(projectDir, 'src/routes/sentry-example/+server.js'));
+    checkFileExists(
+      path.resolve(projectDir, 'src/routes/sentry-example/+page.svelte'),
+    );
+    checkFileExists(
+      path.resolve(projectDir, 'src/routes/sentry-example/+server.js'),
+    );
   });
 
   test('vite.config contains sentry plugin', () => {
-    checkFileContents(path.resolve(projectDir, 'vite.config.ts'), `plugins: [sentrySvelteKit({
+    checkFileContents(
+      path.resolve(projectDir, 'vite.config.ts'),
+      `plugins: [sentrySvelteKit({
         sourceMapsUploadOptions: {
-`);
+`,
+    );
   });
 
   test('hook files created', () => {
@@ -129,15 +145,22 @@ function checkSvelteKitProject(projectDir: string, integration: Integration, opt
   });
 
   test('builds successfully', async () => {
-    await checkIfBuilds(projectDir, 'Successfully uploaded source maps to Sentry');
+    await checkIfBuilds(projectDir);
   });
 
   test('runs on dev mode correctly', async () => {
-    await checkIfRunsOnDevMode(projectDir, options?.devModeExpectedOutput || 'ready in');
+    await checkIfRunsOnDevMode(
+      projectDir,
+      options?.devModeExpectedOutput || 'ready in',
+    );
   });
 
   test('runs on prod mode correctly', async () => {
-    await checkIfRunsOnProdMode(projectDir, options?.prodModeExpectedOutput || 'to expose', 'preview');
+    await checkIfRunsOnProdMode(
+      projectDir,
+      options?.prodModeExpectedOutput || 'to expose',
+      'preview',
+    );
   });
 }
 
@@ -161,10 +184,9 @@ describe('Sveltekit', () => {
     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({
+      checkFileContents(path.resolve(projectDir, 'src/hooks.client.ts'), [
+        `import * as Sentry from '@sentry/sveltekit';`,
+        `Sentry.init({
   dsn: '${TEST_ARGS.PROJECT_DSN}',
 
   tracesSampleRate: 1.0,
@@ -179,22 +201,24 @@ describe('Sveltekit', () => {
 
   // If you don't want to use Session Replay, just remove the line below:
   integrations: [replayIntegration()],
-});`, 'export const handleError = handleErrorWithSentry(']);
+});`,
+        '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({
+      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,
-});`, 'export const handleError = handleErrorWithSentry();']);
+});`,
+        'export const handleError = handleErrorWithSentry();',
+      ]);
     });
   });
 
@@ -206,17 +230,21 @@ describe('Sveltekit', () => {
     );
 
     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,
-        )
-      });
+      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(() => {
@@ -229,27 +257,28 @@ describe('Sveltekit', () => {
     // 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({
+      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(']);
+})`,
+        '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({
+      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();']);
+})`,
+        'export const handleError = Sentry.handleErrorWithSentry();',
+      ]);
     });
   });
 });
-

package/e2e-tests/utils/index.ts

@@ -80,6 +80,36 @@ export class WizardTestEnv {
     return outputPromise;
   }
 
+  /**
+   * Waits for the task to exit with a given `statusCode`.
+   *
+   * @returns a promise that resolves to `true` if the run ends with the status
+   * code, or it rejects when the `timeout` was reached.
+   */
+  waitForStatusCode(
+    statusCode: number | null,
+    options: {
+      /** Timeout in ms */
+      timeout?: number;
+    } = {},
+  ) {
+    const { timeout } = {
+      timeout: 60_000,
+      ...options,
+    };
+
+    return new Promise<boolean>((resolve, reject) => {
+      const timeoutId = setTimeout(() => {
+        reject(new Error(`Timeout waiting for status code: ${statusCode}`));
+      }, timeout);
+
+      this.taskHandle.on('exit', (code: number | null) => {
+        clearTimeout(timeoutId);
+        resolve(code === statusCode);
+      });
+    });
+  }
+
   /**
    * Waits for the provided output with `.includes()` logic.
    *
@@ -318,19 +348,16 @@ export function checkEnvBuildPlugin(projectDir: string) {
 }
 
 /**
- * Check if the project builds
+ * Check if the project builds and ends with status code 0.
  * @param projectDir
  */
-export async function checkIfBuilds(
-  projectDir: string,
-  expectedOutput: string,
-) {
+export async function checkIfBuilds(projectDir: string) {
   const testEnv = new WizardTestEnv('npm', ['run', 'build'], {
     cwd: projectDir,
   });
 
   await expect(
-    testEnv.waitForOutput(expectedOutput, {
+    testEnv.waitForStatusCode(0, {
       timeout: 120_000,
     }),
   ).resolves.toBe(true);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/wizard",
-  "version": "3.38.0",
+  "version": "3.39.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/nextjs/nextjs-wizard.ts

@@ -926,7 +926,7 @@ async function createExamplePage(
  * It's valuable enough to for users to justify asking the additional question.
  */
 async function askShouldSetTunnelRoute() {
-  return await traceStep('ask-tunnelRoute-option', async () => {
+  return await traceStep('ask-tunnelRoute-option', async (span) => {
     const shouldSetTunnelRoute = await abortIfCancelled(
       clack.select({
         message:
@@ -953,6 +953,9 @@ async function askShouldSetTunnelRoute() {
       );
     }
 
+    span?.setAttribute('tunnelRoute', shouldSetTunnelRoute);
+    Sentry.setTag('tunnelRoute', shouldSetTunnelRoute);
+
     return shouldSetTunnelRoute;
   });
 }

package/src/sourcemaps/sourcemaps-wizard.ts

@@ -267,13 +267,9 @@ export async function configureCI(
     'create-react-app',
   ].includes(selectedTool);
 
-  // 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;
+  const authTokenFile = isCliBasedFlowTool
+    ? SENTRY_CLI_RC_FILE
+    : SENTRY_DOT_ENV_FILE;
 
   if (!isUsingCI) {
     clack.log.info(

package/src/telemetry.ts

@@ -9,6 +9,7 @@ import {
   setTag,
   startSpan,
   flush,
+  Span,
 } from '@sentry/node';
 import packageJson from '../package.json';
 import { WizardOptions } from './utils/types';
@@ -110,9 +111,12 @@ function createSentryInstance(enabled: boolean, integration: string) {
   return { sentryHub: hub, sentryClient: client };
 }
 
-export function traceStep<T>(step: string, callback: () => T): T {
+export function traceStep<T>(
+  step: string,
+  callback: (span: Span | undefined) => T,
+): T {
   updateProgress(step);
-  return startSpan({ name: step, op: 'wizard.step' }, () => callback());
+  return startSpan({ name: step, op: 'wizard.step' }, (span) => callback(span));
 }
 
 export function updateProgress(step: string) {

package/src/utils/clack-utils.ts

@@ -1096,9 +1096,10 @@ async function askForWizardLogin(options: {
 
   if (!hasSentryAccount) {
     loginUrl.searchParams.set('signup', '1');
-    if (options.platform) {
-      loginUrl.searchParams.set('project_platform', options.platform);
-    }
+  }
+
+  if (options.platform) {
+    loginUrl.searchParams.set('project_platform', options.platform);
   }
 
   if (options.promoCode) {

package/src/utils/package-manager.ts

@@ -9,7 +9,6 @@ import { getPackageDotJson, updatePackageDotJson } from './clack-utils';
 export interface PackageManager {
   name: string;
   label: string;
-  lockFile: string;
   installCommand: string;
   buildCommand: string;
   /* The command that the package manager uses to run a script from package.json */
@@ -22,12 +21,14 @@ export interface PackageManager {
 export const BUN: PackageManager = {
   name: 'bun',
   label: 'Bun',
-  lockFile: 'bun.lockb',
   installCommand: 'bun add',
   buildCommand: 'bun run build',
   runScriptCommand: 'bun run',
   flags: '',
-  detect: () => fs.existsSync(path.join(process.cwd(), BUN.lockFile)),
+  detect: () =>
+    ['bun.lockb', 'bun.lock'].some((lockFile) =>
+      fs.existsSync(path.join(process.cwd(), lockFile)),
+    ),
   addOverride: async (pkgName, pkgVersion): Promise<void> => {
     const packageDotJson = await getPackageDotJson();
     const overrides = packageDotJson.overrides || {};
@@ -44,7 +45,6 @@ export const BUN: PackageManager = {
 export const YARN_V1: PackageManager = {
   name: 'yarn',
   label: 'Yarn V1',
-  lockFile: 'yarn.lock',
   installCommand: 'yarn add',
   buildCommand: 'yarn build',
   runScriptCommand: 'yarn',
@@ -52,7 +52,7 @@ export const YARN_V1: PackageManager = {
   detect: () => {
     try {
       return fs
-        .readFileSync(path.join(process.cwd(), YARN_V1.lockFile), 'utf-8')
+        .readFileSync(path.join(process.cwd(), 'yarn.lock'), 'utf-8')
         .slice(0, 500)
         .includes('yarn lockfile v1');
     } catch (e) {
@@ -76,7 +76,6 @@ export const YARN_V1: PackageManager = {
 export const YARN_V2: PackageManager = {
   name: 'yarn',
   label: 'Yarn V2/3/4',
-  lockFile: 'yarn.lock',
   installCommand: 'yarn add',
   buildCommand: 'yarn build',
   runScriptCommand: 'yarn',
@@ -84,7 +83,7 @@ export const YARN_V2: PackageManager = {
   detect: () => {
     try {
       return fs
-        .readFileSync(path.join(process.cwd(), YARN_V2.lockFile), 'utf-8')
+        .readFileSync(path.join(process.cwd(), 'yarn.lock'), 'utf-8')
         .slice(0, 500)
         .includes('__metadata');
     } catch (e) {
@@ -107,12 +106,11 @@ export const YARN_V2: PackageManager = {
 export const PNPM: PackageManager = {
   name: 'pnpm',
   label: 'PNPM',
-  lockFile: 'pnpm-lock.yaml',
   installCommand: 'pnpm add',
   buildCommand: 'pnpm build',
   runScriptCommand: 'pnpm',
   flags: '--ignore-workspace-root-check',
-  detect: () => fs.existsSync(path.join(process.cwd(), PNPM.lockFile)),
+  detect: () => fs.existsSync(path.join(process.cwd(), 'pnpm-lock.yaml')),
   addOverride: async (pkgName, pkgVersion): Promise<void> => {
     const packageDotJson = await getPackageDotJson();
     const pnpm = packageDotJson.pnpm || {};
@@ -133,12 +131,11 @@ export const PNPM: PackageManager = {
 export const NPM: PackageManager = {
   name: 'npm',
   label: 'NPM',
-  lockFile: 'package-lock.json',
   installCommand: 'npm add',
   buildCommand: 'npm run build',
   runScriptCommand: 'npm run',
   flags: '',
-  detect: () => fs.existsSync(path.join(process.cwd(), NPM.lockFile)),
+  detect: () => fs.existsSync(path.join(process.cwd(), 'package-lock.json')),
   addOverride: async (pkgName, pkgVersion): Promise<void> => {
     const packageDotJson = await getPackageDotJson();
     const overrides = packageDotJson.overrides || {};