@sentry/wizard 3.26.0 → 3.27.0

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();

package/test/nextjs/templates.test.ts

@@ -1,6 +1,244 @@
-import { getWithSentryConfigOptionsTemplate } from '../../src/nextjs/templates';
+import {
+  getSentryConfigContents,
+  getWithSentryConfigOptionsTemplate,
+} from '../../src/nextjs/templates';
+
+describe('Next.js code templates', () => {
+  describe('getSentryConfigContents', () => {
+    describe('client-side', () => {
+      it('generates client-side Sentry config with all features enabled', () => {
+        const template = getSentryConfigContents('my-dsn', 'client', {
+          performance: true,
+          replay: true,
+        });
+
+        expect(template).toMatchInlineSnapshot(`
+          "// This file configures the initialization of Sentry on the client.
+          // The config you add here will be used whenever a users loads a page in their browser.
+          // https://docs.sentry.io/platforms/javascript/guides/nextjs/
+
+          import * as Sentry from "@sentry/nextjs";
+
+          Sentry.init({
+            dsn: "my-dsn",
+
+            // Add optional integrations for additional features
+            integrations: [
+              Sentry.replayIntegration(),
+            ],
+
+            // Define how likely traces are sampled. Adjust this value in production, or use tracesSampler for greater control.
+            tracesSampleRate: 1,
+
+            // Define how likely Replay events are sampled.
+            // 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,
+
+            // Define how likely Replay events are sampled when an error occurs.
+            replaysOnErrorSampleRate: 1.0,
+
+            // Setting this option to true will print useful information to the console while you're setting up Sentry.
+            debug: false,
+          });
+          "
+        `);
+      });
+
+      it('generates client-side Sentry config with performance monitoring disabled', () => {
+        const template = getSentryConfigContents('my-dsn', 'client', {
+          performance: false,
+          replay: true,
+        });
+
+        expect(template).toMatchInlineSnapshot(`
+          "// This file configures the initialization of Sentry on the client.
+          // The config you add here will be used whenever a users loads a page in their browser.
+          // https://docs.sentry.io/platforms/javascript/guides/nextjs/
+
+          import * as Sentry from "@sentry/nextjs";
+
+          Sentry.init({
+            dsn: "my-dsn",
+
+            // Add optional integrations for additional features
+            integrations: [
+              Sentry.replayIntegration(),
+            ],
+
+            // Define how likely Replay events are sampled.
+            // 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,
+
+            // Define how likely Replay events are sampled when an error occurs.
+            replaysOnErrorSampleRate: 1.0,
+
+            // Setting this option to true will print useful information to the console while you're setting up Sentry.
+            debug: false,
+          });
+          "
+        `);
+      });
+
+      it('generates client-side Sentry config with session replay disabled', () => {
+        const template = getSentryConfigContents('my-dsn', 'client', {
+          performance: true,
+          replay: false,
+        });
+
+        expect(template).toMatchInlineSnapshot(`
+          "// This file configures the initialization of Sentry on the client.
+          // The config you add here will be used whenever a users loads a page in their browser.
+          // https://docs.sentry.io/platforms/javascript/guides/nextjs/
+
+          import * as Sentry from "@sentry/nextjs";
+
+          Sentry.init({
+            dsn: "my-dsn",
+
+            // Define how likely traces are sampled. Adjust this value in production, or use tracesSampler for greater control.
+            tracesSampleRate: 1,
+
+            // Setting this option to true will print useful information to the console while you're setting up Sentry.
+            debug: false,
+          });
+          "
+        `);
+      });
+    });
+
+    describe('server-side', () => {
+      it('generates server-side Sentry config with all features enabled', () => {
+        const template = getSentryConfigContents('my-dsn', 'server', {
+          performance: true,
+          replay: true,
+        });
+
+        expect(template).toMatchInlineSnapshot(`
+          "// This file configures the initialization of Sentry on the server.
+          // The config you add here will be used whenever the server handles a request.
+          // https://docs.sentry.io/platforms/javascript/guides/nextjs/
+
+          import * as Sentry from "@sentry/nextjs";
+
+          Sentry.init({
+            dsn: "my-dsn",
+
+            // Define how likely traces are sampled. Adjust this value in production, or use tracesSampler for greater control.
+            tracesSampleRate: 1,
+
+            // Setting this option to true will print useful information to the console while you're setting up Sentry.
+            debug: false,
+          });
+          "
+        `);
+      });
+
+      it('generates server-side Sentry config with performance monitoring disabled', () => {
+        const template = getSentryConfigContents('my-dsn', 'server', {
+          performance: false,
+          replay: true,
+        });
+
+        expect(template).toMatchInlineSnapshot(`
+          "// This file configures the initialization of Sentry on the server.
+          // The config you add here will be used whenever the server handles a request.
+          // https://docs.sentry.io/platforms/javascript/guides/nextjs/
+
+          import * as Sentry from "@sentry/nextjs";
+
+          Sentry.init({
+            dsn: "my-dsn",
+
+            // Setting this option to true will print useful information to the console while you're setting up Sentry.
+            debug: false,
+          });
+          "
+        `);
+      });
+
+      it('generates server-side Sentry config with spotlight disabled', () => {
+        const template = getSentryConfigContents('my-dsn', 'server', {
+          performance: true,
+          replay: true,
+        });
+
+        expect(template).toMatchInlineSnapshot(`
+          "// This file configures the initialization of Sentry on the server.
+          // The config you add here will be used whenever the server handles a request.
+          // https://docs.sentry.io/platforms/javascript/guides/nextjs/
+
+          import * as Sentry from "@sentry/nextjs";
+
+          Sentry.init({
+            dsn: "my-dsn",
+
+            // Define how likely traces are sampled. Adjust this value in production, or use tracesSampler for greater control.
+            tracesSampleRate: 1,
+
+            // Setting this option to true will print useful information to the console while you're setting up Sentry.
+            debug: false,
+          });
+          "
+        `);
+      });
+    });
+
+    describe('edge', () => {
+      it('generates edge Sentry config with all features enabled', () => {
+        const template = getSentryConfigContents('my-dsn', 'edge', {
+          performance: true,
+          replay: true,
+        });
+
+        expect(template).toMatchInlineSnapshot(`
+          "// This file configures the initialization of Sentry for edge features (middleware, edge routes, and so on).
+          // The config you add here will be used whenever one of the edge features is loaded.
+          // Note that this config is unrelated to the Vercel Edge Runtime and is also required when running locally.
+          // https://docs.sentry.io/platforms/javascript/guides/nextjs/
+
+          import * as Sentry from "@sentry/nextjs";
+
+          Sentry.init({
+            dsn: "my-dsn",
+
+            // Define how likely traces are sampled. Adjust this value in production, or use tracesSampler for greater control.
+            tracesSampleRate: 1,
+
+            // Setting this option to true will print useful information to the console while you're setting up Sentry.
+            debug: false,
+          });
+          "
+        `);
+      });
+
+      it('generates edge Sentry config with performance monitoring disabled', () => {
+        const template = getSentryConfigContents('my-dsn', 'edge', {
+          performance: false,
+          replay: true,
+        });
+
+        expect(template).toMatchInlineSnapshot(`
+          "// This file configures the initialization of Sentry for edge features (middleware, edge routes, and so on).
+          // The config you add here will be used whenever one of the edge features is loaded.
+          // Note that this config is unrelated to the Vercel Edge Runtime and is also required when running locally.
+          // https://docs.sentry.io/platforms/javascript/guides/nextjs/
+
+          import * as Sentry from "@sentry/nextjs";
+
+          Sentry.init({
+            dsn: "my-dsn",
+
+            // Setting this option to true will print useful information to the console while you're setting up Sentry.
+            debug: false,
+          });
+          "
+        `);
+      });
+    });
+  });
 
-describe('NextJS code templates', () => {
   describe('getWithSentryConfigOptionsTemplate', () => {
     it('generates options for SaaS', () => {
       const template = getWithSentryConfigOptionsTemplate({

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

@@ -38,7 +38,8 @@ describe('addSentryCommandToBuildCommand', () => {
     [
       packageManagerHelpers.NPM,
       packageManagerHelpers.PNPM,
-      packageManagerHelpers.YARN,
+      packageManagerHelpers.YARN_V1,
+      packageManagerHelpers.YARN_V2,
       packageManagerHelpers.BUN,
     ],
   ])('adds the cli command to the script command (%s)', async (_, pacMan) => {