@sentry/wizard 3.26.0 → 3.28.0

package/src/sveltekit/sdk-setup.ts

@@ -15,7 +15,11 @@ import { builders, generateCode, loadFile, parseModule } from 'magicast';
 // @ts-ignore - magicast is ESM and TS complains about that. It works though
 import { addVitePlugin } from 'magicast/helpers';
 import { getClientHooksTemplate, getServerHooksTemplate } from './templates';
-import { abortIfCancelled, isUsingTypeScript } from '../utils/clack-utils';
+import {
+  abortIfCancelled,
+  featureSelectionPrompt,
+  isUsingTypeScript,
+} from '../utils/clack-utils';
 import { debug } from '../utils/debug';
 import { findFile, hasSentryContent } from '../utils/ast-utils';
 
@@ -50,6 +54,23 @@ export async function createOrMergeSvelteKitFiles(
   projectInfo: ProjectInfo,
   svelteConfig: PartialSvelteConfig,
 ): Promise<void> {
+  const selectedFeatures = await featureSelectionPrompt([
+    {
+      id: 'performance',
+      prompt: `Do you want to enable ${chalk.bold(
+        'Tracing',
+      )} to track the performance of your application?`,
+      enabledHint: 'recommended',
+    },
+    {
+      id: 'replay',
+      prompt: `Do you want to enable ${chalk.bold(
+        'Sentry Session Replay',
+      )} to get a video-like reproduction of errors during a user session?`,
+      enabledHint: 'recommended, but increases bundle size',
+    },
+  ] as const);
+
   const { clientHooksPath, serverHooksPath } = getHooksConfigDirs(svelteConfig);
 
   // full file paths with correct file ending (or undefined if not found)
@@ -68,9 +89,19 @@ export async function createOrMergeSvelteKitFiles(
   );
   if (!originalClientHooksFile) {
     clack.log.info('No client hooks file found, creating a new one.');
-    await createNewHooksFile(`${clientHooksPath}.${fileEnding}`, 'client', dsn);
+    await createNewHooksFile(
+      `${clientHooksPath}.${fileEnding}`,
+      'client',
+      dsn,
+      selectedFeatures,
+    );
   } else {
-    await mergeHooksFile(originalClientHooksFile, 'client', dsn);
+    await mergeHooksFile(
+      originalClientHooksFile,
+      'client',
+      dsn,
+      selectedFeatures,
+    );
   }
 
   Sentry.setTag(
@@ -79,9 +110,19 @@ export async function createOrMergeSvelteKitFiles(
   );
   if (!originalServerHooksFile) {
     clack.log.info('No server hooks file found, creating a new one.');
-    await createNewHooksFile(`${serverHooksPath}.${fileEnding}`, 'server', dsn);
+    await createNewHooksFile(
+      `${serverHooksPath}.${fileEnding}`,
+      'server',
+      dsn,
+      selectedFeatures,
+    );
   } else {
-    await mergeHooksFile(originalServerHooksFile, 'server', dsn);
+    await mergeHooksFile(
+      originalServerHooksFile,
+      'server',
+      dsn,
+      selectedFeatures,
+    );
   }
 
   if (viteConfig) {
@@ -123,11 +164,15 @@ async function createNewHooksFile(
   hooksFileDest: string,
   hooktype: 'client' | 'server',
   dsn: string,
+  selectedFeatures: {
+    performance: boolean;
+    replay: boolean;
+  },
 ): Promise<void> {
   const filledTemplate =
     hooktype === 'client'
-      ? getClientHooksTemplate(dsn)
-      : getServerHooksTemplate(dsn);
+      ? getClientHooksTemplate(dsn, selectedFeatures)
+      : getServerHooksTemplate(dsn, selectedFeatures);
 
   await fs.promises.mkdir(path.dirname(hooksFileDest), { recursive: true });
   await fs.promises.writeFile(hooksFileDest, filledTemplate);
@@ -151,6 +196,10 @@ async function mergeHooksFile(
   hooksFile: string,
   hookType: 'client' | 'server',
   dsn: string,
+  selectedFeatures: {
+    performance: boolean;
+    replay: boolean;
+  },
 ): Promise<void> {
   const originalHooksMod = await loadFile(hooksFile);
 
@@ -184,9 +233,9 @@ Skipping adding Sentry functionality to.`,
   await modifyAndRecordFail(
     () => {
       if (hookType === 'client') {
-        insertClientInitCall(dsn, originalHooksMod);
+        insertClientInitCall(dsn, originalHooksMod, selectedFeatures);
       } else {
-        insertServerInitCall(dsn, originalHooksMod);
+        insertServerInitCall(dsn, originalHooksMod, selectedFeatures);
       }
     },
     'init-call-injection',
@@ -224,20 +273,38 @@ function insertClientInitCall(
   dsn: string,
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   originalHooksMod: ProxifiedModule<any>,
+  selectedFeatures: {
+    performance: boolean;
+    replay: boolean;
+  },
 ): void {
   const initCallComment = `
-    // If you don't want to use Session Replay, remove the \`Replay\` integration, 
+    // If you don't want to use Session Replay, remove the \`Replay\` integration,
     // \`replaysSessionSampleRate\` and \`replaysOnErrorSampleRate\` options.`;
 
+  const initArgs: {
+    dsn: string;
+    tracesSampleRate?: number;
+    replaysSessionSampleRate?: number;
+    replaysOnErrorSampleRate?: number;
+    integrations?: string[];
+  } = {
+    dsn,
+  };
+
+  if (selectedFeatures.performance) {
+    initArgs.tracesSampleRate = 1.0;
+  }
+
+  if (selectedFeatures.replay) {
+    initArgs.replaysSessionSampleRate = 0.1;
+    initArgs.replaysOnErrorSampleRate = 1.0;
+    initArgs.integrations = [builders.functionCall('Sentry.replayIntegration')];
+  }
+
   // This assignment of any values is fine because we're just creating a function call in magicast
   // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-  const initCall = builders.functionCall('Sentry.init', {
-    dsn,
-    tracesSampleRate: 1.0,
-    replaysSessionSampleRate: 0.1,
-    replaysOnErrorSampleRate: 1.0,
-    integrations: [builders.functionCall('Sentry.replayIntegration')],
-  });
+  const initCall = builders.functionCall('Sentry.init', initArgs);
 
   // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
   const initCallWithComment = builders.raw(
@@ -262,13 +329,24 @@ function insertServerInitCall(
   dsn: string,
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   originalHooksMod: ProxifiedModule<any>,
+  selectedFeatures: {
+    performance: boolean;
+  },
 ): void {
+  const initArgs: {
+    dsn: string;
+    tracesSampleRate?: number;
+  } = {
+    dsn,
+  };
+
+  if (selectedFeatures.performance) {
+    initArgs.tracesSampleRate = 1.0;
+  }
+
   // This assignment of any values is fine because we're just creating a function call in magicast
   // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-  const initCall = builders.functionCall('Sentry.init', {
-    dsn,
-    tracesSampleRate: 1.0,
-  });
+  const initCall = builders.functionCall('Sentry.init', initArgs);
 
   const originalHooksModAST = originalHooksMod.$ast as Program;
 
@@ -546,7 +624,7 @@ export default defineConfig({
       sourceMapsUploadOptions: {
         org: '${org}',
         project: '${project}',${selfHosted ? `\n        url: '${url}',` : ''}
-      }  
+      }
     }),`)}
     sveltekit(),
   ]

package/src/sveltekit/sveltekit-wizard.ts

@@ -17,7 +17,7 @@ import {
   printWelcome,
 } from '../utils/clack-utils';
 import { getPackageVersion, hasPackageInstalled } from '../utils/package-json';
-import { WizardOptions } from '../utils/types';
+import type { WizardOptions } from '../utils/types';
 import { createExamplePage } from './sdk-example';
 import { createOrMergeSvelteKitFiles, loadSvelteConfig } from './sdk-setup';
 import { traceStep, withTelemetry } from '../telemetry';

package/src/sveltekit/templates.ts

@@ -1,21 +1,36 @@
-export function getClientHooksTemplate(dsn: string) {
+export function getClientHooksTemplate(
+  dsn: string,
+  selectedFeatures: {
+    performance: boolean;
+    replay: boolean;
+  },
+) {
   return `import { handleErrorWithSentry, replayIntegration } from "@sentry/sveltekit";
 import * as Sentry from '@sentry/sveltekit';
 
 Sentry.init({
   dsn: '${dsn}',
+${
+  selectedFeatures.performance
+    ? `
   tracesSampleRate: 1.0,
-
-  // This sets the sample rate to be 10%. You may want this to be 100% while
+`
+    : ''
+}
+${
+  selectedFeatures.replay
+    ? `  // This sets the sample rate to be 10%. You may want this to be 100% while
   // in development and sample at a lower rate in production
   replaysSessionSampleRate: 0.1,
 
   // If the entire session is not sampled, use the below sample rate to sample
   // sessions when an error occurs.
   replaysOnErrorSampleRate: 1.0,
-  
+
   // If you don't want to use Session Replay, just remove the line below:
-  integrations: [replayIntegration()],
+  integrations: [replayIntegration()],`
+    : ''
+}
 });
 
 // If you have a custom error handler, pass it to \`handleErrorWithSentry\`
@@ -23,17 +38,28 @@ export const handleError = handleErrorWithSentry();
 `;
 }
 
-export function getServerHooksTemplate(dsn: string) {
+export function getServerHooksTemplate(
+  dsn: string,
+  selectedFeatures: {
+    performance: boolean;
+    replay: boolean;
+  },
+) {
   return `import { sequence } from "@sveltejs/kit/hooks";
 import { handleErrorWithSentry, sentryHandle } from "@sentry/sveltekit";
 import * as Sentry from '@sentry/sveltekit';
 
 Sentry.init({
   dsn: '${dsn}',
+${
+  selectedFeatures.performance
+    ? `
   tracesSampleRate: 1.0,
-
+`
+    : ''
+}
   // uncomment the line below to enable Spotlight (https://spotlightjs.com)
-  // spotlight: import.meta.env.DEV,  
+  // spotlight: import.meta.env.DEV,
 });
 
 // If you have custom handlers, make sure to place them after \`sentryHandle()\` in the \`sequence\` function.
@@ -57,9 +83,9 @@ export function getSentryExampleSveltePage(options: {
     ? `${options.url}organizations/${options.orgSlug}/issues/?project=${options.projectId}`
     : `https://${options.orgSlug}.sentry.io/issues/?project=${options.projectId}`;
 
-  return `<!-- 
+  return `<!--
 This is just a very simple page with a button to throw an example error.
-Feel free to delete this file and the entire sentry route.  
+Feel free to delete this file and the entire sentry route.
 -->
 
 <script>

package/src/utils/clack-utils.ts

@@ -10,7 +10,7 @@ import { setInterval } from 'timers';
 import { URL } from 'url';
 import * as Sentry from '@sentry/node';
 import { hasPackageInstalled, PackageDotJson } from './package-json';
-import { SentryProjectData, WizardOptions } from './types';
+import { Feature, SentryProjectData, WizardOptions } from './types';
 import { traceStep } from '../telemetry';
 import {
   detectPackageManger,
@@ -1277,3 +1277,36 @@ export async function askShouldCreateExamplePage(
     ),
   );
 }
+
+export async function featureSelectionPrompt<F extends ReadonlyArray<Feature>>(
+  features: F,
+): Promise<{ [key in F[number]['id']]: boolean }> {
+  return traceStep('feature-selection', async () => {
+    const selectedFeatures: Record<string, boolean> = {};
+
+    for (const feature of features) {
+      const selected = await abortIfCancelled(
+        clack.select({
+          message: feature.prompt,
+          initialValue: true,
+          options: [
+            {
+              value: true,
+              label: 'Yes',
+              hint: feature.enabledHint,
+            },
+            {
+              value: false,
+              label: 'No',
+              hint: feature.disabledHint,
+            },
+          ],
+        }),
+      );
+
+      selectedFeatures[feature.id] = selected;
+    }
+
+    return selectedFeatures as { [key in F[number]['id']]: boolean };
+  });
+}

package/src/utils/package-manager.ts

@@ -14,6 +14,7 @@ export interface PackageManager {
   /* The command that the package manager uses to run a script from package.json */
   runScriptCommand: string;
   flags: string;
+  detect: () => boolean;
 }
 
 export const BUN: PackageManager = {
@@ -24,15 +25,46 @@ export const BUN: PackageManager = {
   buildCommand: 'bun run build',
   runScriptCommand: 'bun run',
   flags: '',
+  detect: () => fs.existsSync(path.join(process.cwd(), BUN.lockFile)),
 };
-export const YARN: PackageManager = {
+export const YARN_V1: PackageManager = {
   name: 'yarn',
-  label: 'Yarn',
+  label: 'Yarn V1',
   lockFile: 'yarn.lock',
   installCommand: 'yarn add',
   buildCommand: 'yarn build',
   runScriptCommand: 'yarn',
   flags: '--ignore-workspace-root-check',
+  detect: () => {
+    try {
+      return fs
+        .readFileSync(path.join(process.cwd(), YARN_V1.lockFile), 'utf-8')
+        .slice(0, 500)
+        .includes('yarn lockfile v1');
+    } catch (e) {
+      return false;
+    }
+  },
+};
+/** YARN V2/3/4 */
+export const YARN_V2: PackageManager = {
+  name: 'yarn',
+  label: 'Yarn V2/3/4',
+  lockFile: 'yarn.lock',
+  installCommand: 'yarn add',
+  buildCommand: 'yarn build',
+  runScriptCommand: 'yarn',
+  flags: '',
+  detect: () => {
+    try {
+      return fs
+        .readFileSync(path.join(process.cwd(), YARN_V2.lockFile), 'utf-8')
+        .slice(0, 500)
+        .includes('__metadata');
+    } catch (e) {
+      return false;
+    }
+  },
 };
 export const PNPM: PackageManager = {
   name: 'pnpm',
@@ -42,6 +74,7 @@ export const PNPM: PackageManager = {
   buildCommand: 'pnpm build',
   runScriptCommand: 'pnpm',
   flags: '--ignore-workspace-root-check',
+  detect: () => fs.existsSync(path.join(process.cwd(), PNPM.lockFile)),
 };
 export const NPM: PackageManager = {
   name: 'npm',
@@ -51,14 +84,15 @@ export const NPM: PackageManager = {
   buildCommand: 'npm run build',
   runScriptCommand: 'npm run',
   flags: '',
+  detect: () => fs.existsSync(path.join(process.cwd(), NPM.lockFile)),
 };
 
-export const packageManagers = [BUN, YARN, PNPM, NPM];
+export const packageManagers = [BUN, YARN_V1, YARN_V2, PNPM, NPM];
 
 export function detectPackageManger(): PackageManager | null {
   return traceStep('detect-package-manager', () => {
     for (const packageManager of packageManagers) {
-      if (fs.existsSync(path.join(process.cwd(), packageManager.lockFile))) {
+      if (packageManager.detect()) {
         Sentry.setTag('package-manager', packageManager.name);
         return packageManager;
       }

package/src/utils/types.ts

@@ -44,3 +44,10 @@ export type WizardOptions = {
     selfHosted: boolean;
   };
 };
+
+export interface Feature {
+  id: string;
+  prompt: string;
+  enabledHint?: string;
+  disabledHint?: string;
+}

package/src/utils/url.ts

@@ -15,8 +15,12 @@ export function getIssueStreamUrl({
   projectId: string;
 }): string {
   const urlObject = new URL(url);
-  urlObject.host = `${orgSlug}.${urlObject.host}`;
-  urlObject.pathname = '/issues/';
+  if (urlObject.host === 'sentry.io') {
+    urlObject.host = `${orgSlug}.${urlObject.host}`;
+    urlObject.pathname = '/issues/';
+  } else {
+    urlObject.pathname = `/organizations/${orgSlug}/issues/`;
+  }
   urlObject.searchParams.set('project', projectId);
 
   return urlObject.toString();